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 WinQueryAtomLength(hAtomTbl, atom)
HATOMTBL hAtomTbl;    /* handle of the atom table */
ATOM atom;            /* atom                     */
 
The WinQueryAtomLength function queries the length of a string associated
with the passed atom. The purpose of this function is to allow an
application to determine the size of the buffer to pass to the
WinQueryAtomName function.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hAtomTbl   Identifies an atom table. This handle must have been created by a
           previous call to the WinCreateAtomTable function.
 
atom       Specifies the atom whose length is to be returned.
 
Return Value
 
The return value is the length of the string associated with the atom, not
including the null terminating byte. If the specified atom or atom table is
invalid, the return value is zero. Integer atoms always return a length of
6.
 
See Also
 
WinCreateAtomTable, WinQueryAtomName
 
                                      ♦