DspText

Cicode Programming Reference > Cicode Function Categories > Display Functions Introduction > DspText

DspText

Displays text at a specified AN location. This function does the same operation as DspStr(), however it uses a font number rather than a font name.

Note: This function is only used for V3.xx and V4.xx animations, and was superseded in later releases.

Syntax

DspText(hAN, iFont, sText [, iLength] [, iAlignMode] [, iLengthMode])

hAN:

The AN where the text will be displayed.

iFont:

The font number that is used to display the text. (To use the default font, set to -1.)

sText:

The text to display.

iLength:

Length of the Text to display, either in characters or pixels depending on Mode (default -1, no truncation)

iAlignMode:

The alignment of the text string:

0 - Left Justified (default)

1 - Right Justified.

2 - Center Justified.

iLengthMode:

The length mode of the text string:

0 - Length as pixels truncated (default)

1 - Length as pixels truncated with ellipsis

2 - Length interpreted as characters.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

DspStr, DspFont, DspFontHnd

Example

/* Displays "Display this text" at AN25 using the font defined as
BigFont. */

hBigFont=DspFontHnd("BigFont");

DspText(25,hBigFont,"Display this text");