GlobalDeleteAtom

Syntax

ATOM GlobalDeleteAtom(nAtom)

This function decreases the reference count of a global atom by one. If the atom's reference count becomes zero, this function removes the associated string from the atom table. (A global atom is an atom that is available to all Windows applications.)

An atom's reference count specifies the number of times the atom has been added to the atom table. The GlobalAddAtom function increases the count on each call; the GlobalDeleteAtom function decreases the count on each call. GlobalDeleteAtom 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 nAtom if the function failed and the atom has not been deleted.