Prev Next

GetAtomName info  Overview  Group

The GetAtomName function retrieves a copy of the character string associated with the specified local atom. This function replaces the GetAtomHandle function.

UINT GetAtomName(

    ATOM nAtom,

// atom identifying character string

    LPTSTR lpBuffer,

// address of buffer for atom string

    int nSize 

// size of buffer

   );

Parameters

nAtom
Specifies the local atom that identifies the character string to be retrieved.
lpBuffer
Points to the buffer for the character string.
nSize
Specifies the size, in characters, of the buffer.

Return Values

If the function succeeds, the return value is the length of the string copied to the buffer, in characters, not including the terminating null character.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The string returned for an integer atom (an atom created by the MAKEINTATOM macro) is a null-terminated string in which the first character is a pound sign (#) and the remaining characters represent the unsigned integer originally passed to MAKEINTATOM.

See Also

AddAtom, DeleteAtom, FindAtom, GlobalAddAtom, GlobalDeleteAtom, GlobalFindAtom, GlobalGetAtomName, MAKEINTATOM