DspInfoDestroy | Display Functions

Cicode Programming Reference > Cicode Function Categories > Display Functions > DspInfoDestroy

DspInfoDestroy

Destroys an object information block created by DspInfoNew(). You should destroy an object information block when you no longer need it, to free Citect SCADA resources.

When the page (with which the object is associated) is closed, Citect SCADA automatically destroys the object information block.

Syntax

DspInfoDestroy(hInfo)

hInfo:

The object information block handle, as returned by DspInfoNew(). This handle identifies the table (or block) where all object data is stored.

Return Value

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

Related Functions

DspInfo, DspInfoNew, DspInfoField, DspInfoValid

Example

hInfo=DspInfoNew(20);
! Do animation operation
DspInfoDestroy(hInfo);