GlobalDeleteAtom

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function decrements the reference count of a global string atom. When GlobalDeleteAtom decrements the reference count for the atom to zero, GlobalDeleteAtom removes the string associated with the atom from the global atom table.

Syntax

ATOM GlobalDeleteAtom(
  ATOM nAtom
);

Parameters

• nAtom
  [in] Atom that identifies the character string that you want to delete or for which you want to decrement the reference count.

Return Value

0 indicates success or that the atom is an integer atom. The value of the nAtom parameter indicates failure. To get extended error information, call GetLastError.

Remarks

A reference count for a string atom specifies the number of times that an application has added the string to the atom table. The GlobalAddAtom function increments the reference count of a string that already exists in the global atom table each time that an application calls GlobalAddAtom for that string.

Each call to GlobalAddAtom should have a corresponding call to GlobalDeleteAtom. Do not call GlobalDeleteAtom more times than you call GlobalAddAtom or you may delete the atom while other applications are using the atom.

GlobalDeleteAtom does not affect an integer atom. The function always returns 0 for an integer atom.

Requirements

See Also

Reference

GlobalAddAtom
GlobalFindAtom
MAKEINTATOM
Atoms Functions