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

DspAnFree

Note: This function is only used for V3.xx and V4.xx animations, and will be superseded in future releases.

Frees (removes) an AN from the current page. If an animation exists at the animation number, it is deleted before the AN is freed. Use this function to free existing ANs or ANs created with the DspAnNew() function. Please be aware that the ANs are only freed in memory - the change is not persistent. The next time the page is opened it will display the AN.

Syntax

DspAnFree(AN)

AN:

The animation-point number.

Return Value

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

Related Functions

DspAnNew

Example

/* Remove AN20 from the current page. */
DspAnFree(20);

See Also

Display Functions