DspGetTip

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

DspGetTip

Gets the tool tip text associated with an AN.

Syntax

DspGetTip(AN, Mode)

AN:

The AN from which to get the tool tip text. If no object is configured at the AN, the function will return an empty string.

Mode:

0 - Tool tips from all animation records configured at the AN. Tips are concatenated with a newline character between each string. (This mode is only used for V3.xx and V4.xx animations, and has been subsequently superseded.)

1 - The tool tip from the object configured at the AN.

Return Value

The tool tip text (as a string). If no user tip is available, an empty string is returned.

Related Functions

DspSetTip, DspTipMode

Example

!Display the tool tip text on AN19

DspText(19, 0, DspGetTip(KeyGetCursor(), 1));