Skip to content

Latest commit

 

History

History
109 lines (73 loc) · 3.46 KB

nf-winbase-deleteatom.md

File metadata and controls

109 lines (73 loc) · 3.46 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winbase.DeleteAtom
DeleteAtom function (winbase.h)
Decrements the reference count of a local string atom. If the atom's reference count is reduced to zero, DeleteAtom removes the string associated with the atom from the local atom table.
DeleteAtom
DeleteAtom function [Data Exchange]
_win32_DeleteAtom
_win32_deleteatom_cpp
dataxchg.deleteatom
winbase/DeleteAtom
winui._win32_deleteatom
dataxchg\deleteatom.htm
dataxchg
VS|winui|~\winui\windowsuserinterface\dataexchange\atoms\atomreference\atomfunctions\deleteatom.htm
12/05/2018
DeleteAtom, DeleteAtom function [Data Exchange], _win32_DeleteAtom, _win32_deleteatom_cpp, dataxchg.deleteatom, winbase/DeleteAtom, winui._win32_deleteatom
winbase.h
Windows.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Kernel32.lib
Kernel32.dll
Windows
19H1
DeleteAtom
winbase/DeleteAtom
c++
APIRef
kbSyntax
DllExport
Kernel32.dll
API-MS-Win-Core-atoms-l1-1-0.dll
kernel32legacy.dll
API-MS-Win-DownLevel-Kernel32-l2-1-0.dll
DeleteAtom

DeleteAtom function

-description

Decrements the reference count of a local string atom. If the atom's reference count is reduced to zero, DeleteAtom removes the string associated with the atom from the local atom table.

-parameters

-param nAtom [in]

Type: ATOM

The atom to be deleted.

-returns

Type: ATOM

If the function succeeds, the return value is zero.

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

-remarks

A string atom's reference count specifies the number of times the atom has been added to the atom table. The AddAtom function increments the count on each call. The DeleteAtom function decrements the count on each call but removes the string only if the atom's reference count is zero.

Each call to AddAtom should have a corresponding call to DeleteAtom. Do not call DeleteAtom more times than you call AddAtom, or you may delete the atom while other clients are using it.

The DeleteAtom function has no effect on an integer atom (an atom whose value is in the range 0x0001 to 0xBFFF). The function always returns zero for an integer atom.

-see-also

AddAtom

FindAtom

GlobalAddAtom

GlobalDeleteAtom

GlobalFindAtom

MAKEINTATOM

Reference