astAnnul

Annul a pointer to an Object

Description:

This function annuls a pointer to an Object so that it is no longer recognised as a valid pointer by the AST library. Any resources associated with the pointer are released and made available for re-use.

This function also decrements the Object s RefCount attribute by one. If this attribute reaches zero (which happens when the last pointer to the Object is annulled), then the Object is deleted.

Synopsis

AstObject astAnnul( AstObject this )

Parameters:

this
The Object pointer to be annulled.

Applicability

Object
This function applies to all Objects.

Returned Value

astAnnul()
A null Object pointer (AST__NULL) is always returned.

Notes: