ImageGear for C and C++ on Linux v20.0 - Updated
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_ATOM > IG_PDF_atom_from_string

Gets the Atom for the specified string.


Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_atom_from_string(
        LPCSTR lpString,
        LPHIG_PDF_ATOM lphAtom


Name Type Description
lpString LPCSTR The string for which an atom is obtained.
lphAtom LPHIG_PDF_ATOM Atom return value.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.


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.

Is this page helpful?
Yes No
Thanks for your feedback.