DspAnFree

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.

Note: This function was designed to only be used on Cicode objects, or the animation point object from the version 3.xx/4.xx toolbox.

Syntax

DspAnFree(nAN)

nAN:

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