Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Function Group►  ◄Overview►                          ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_WINATOM
 
USHORT WinQueryAtomName(hAtomTbl, atom, pszBuffer, cchBufferMax)
HATOMTBL hAtomTbl;      /* handle of the atom table */
ATOM atom;              /* atom                     */
PSZ pszBuffer;          /* address of the buffer    */
USHORT cchBufferMax;    /* length of the buffer     */
 
The WinQueryAtomName function retrieves an atom name associated with an
atom.
 
Parameter     Description
────────────────────────────────────────────────────────────────────────────
 
hAtomTbl      Identifies an atom table. This handle must have been created
              by a previous call to the WinCreateAtomTable function.
 
atom          Specifies an atom identifying the character string to
              retrieve. For integer atoms, the format of the string is
              #ddddd, where ddddd are decimal digits in the system code page
              (which will be an ASCII code page). No leading zeros are
              generated, and the length can be from three to seven
              characters.
 
pszBuffer     Points to the buffer to receive the character string.
 
cchBufferMax  Specifies the maximum size (in bytes) of the buffer pointed to
              by pszBuffer.
 
Return Value
 
The return value is the actual number of bytes copied to the buffer,
excluding the null terminating byte. If the specified atom or the atom table
is invalid, the return value is zero.
 
See Also
 
WinCreateAtomTable, WinFindAtom, WinQueryAtomLength
 
                                      ♦