Kernel32GlobalAddAtom Method

Adds a character string to the global atom table and returns a unique value (an atom) identifying the string.

Definition

Namespace: DevCase.Win32.NativeMethods
Assembly: DevCase.net48 (in DevCase.net48.dll) Version: 6.0.0.0 (6.0)
XMLNS for XAML: Not mapped to an xmlns.
[DllImportAttribute("Kernel32.dll", CharSet = CharSet.Auto, BestFitMapping = false, 
	ThrowOnUnmappableChar = true, SetLastError = true)]
public static ushort GlobalAddAtom(
	string str
)

Parameters

str  String
The null-terminated string to be added. The string can have a maximum size of 255 bytes.

Strings that differ only in case are considered identical.

The case of the first string of this name added to the table is preserved and returned by the GlobalGetAtomName(UInt16, StringBuilder, Int32) function.

Return Value

UInt16
If the function succeeds, the return value is the newly created atom.

If the function fails, the return value is zero.

To get extended error information, call GetLastWin32Error.

Remarks

See Also