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

DspSym

Note: This function is only used for V3.xx and V4.xx animations. In later releases this function is redundant. The same functionality can be achieved using objects.

Displays a symbol at a specified AN. If the symbol number is 0, any existing symbol (at the AN) is erased.

Syntax

DspSym(AN, Symbol [, Mode] )

AN:

The AN where the symbol will be displayed.

Symbol:

The name of the symbol to display in the format <[LibName.]SymName>. If you do not specify the library name, a symbol from the Global library will display (if it exists).

Mode:

Not used. The mode is always set to 1, which means do not erase the existing symbol, just draw the new symbol.

Return Value

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

Related Functions

DspDel

Example

! Display the centrifuge symbol (from the pumps library) at AN25.
DspSym(25,"Pumps.Centrifuge");
! Display the centrifuge symbol (from the global library) at AN26.
DspSym(26,"Centrifuge");

See Also

Display Functions


[an error occurred while processing this directive]