GetAtomNameW function (winbase.h)

Article
11/20/2024

Retrieves a copy of the character string associated with the specified local atom.

Syntax

UINT GetAtomNameW(
  [in]  ATOM   nAtom,
  [out] LPWSTR lpBuffer,
  [in]  int    nSize
);

Parameters

[in] nAtom

Type: ATOM

The local atom that identifies the character string to be retrieved.

[out] lpBuffer

Type: LPTSTR

The character string.

[in] nSize

Type: int

The size, in characters, of the buffer.

Return value

Type: UINT

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 whose value is in the range 0x0001 to 0xBFFF) is a null-terminated string in which the first character is a pound sign (#) and the remaining characters represent the unsigned integer atom value.

Security Considerations

Using this function incorrectly might compromise the security of your program. Incorrect use of this function includes not correctly specifying the size of the lpBuffer parameter.

Note

The winbase.h header defines GetAtomName as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	winbase.h (include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll

Share via