DeleteAtom

Syntax

ATOM DeleteAtom(nAtom)

This function deletes an atom and, if the atom's reference count is zero, removes the associated string from the atom table.

An atom's reference count specifies the number of times the atom has been added to the atom table. The AddAtom function increases the count on each call; the DeleteAtom function decreases the count on each call. DeleteAtom removes the string only if the atom's reference count is zero.

Parameter Type/Description  

nAtom ATOM Identifies the atom and character string to be deleted.  

Return Value

The return value specifies the outcome of the function. It is NULL if the function is successful. It is equal to the nAtom parameter if the function failed and the atom has not been deleted.