ImageGear Professional DLL v17.1 for Windows Accusoft
IG_PDF_atom_from_string
Send Feedback  
ImageGear Professional DLL v17.1 for Windows > API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_ATOM > IG_PDF_atom_from_string

Glossary Item Box

Gets the Atom for the specified string.

Declaration:

  Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_atom_from_string(
        LPCSTR lpString,
        LPHIG_PDF_ATOM lphAtom
);

Arguments:

lpString The string for which an atom is obtained.
lphAtom Atom return value.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

You can also use this function to create an Atom, since it creates one for the string if one does not already exist.

If an Atom already exists for lpString, the existing Atom is returned. Thus Atoms may be compared for equality of the underlying string.

Because Atoms cannot be deleted, they are useful for strings that are used many times, but are not advisable for strings that have a short lifetime. For the same reason, it is not a good idea to create large numbers of Atoms.

©2012. Accusoft Corporation. All Rights Reserved.