ImageGear for C and C++ on Windows v19.1 - Updated
IG_PDF_atom_get_string
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_ATOM > IG_PDF_atom_get_string

Gets the string associated with the specified Atom.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_atom_get_string(
        HIG_PDF_ATOM hAtom,
        LPCSTR* lpString
);

Arguments:

Name Type Description
hAtom HIG_PDF_ATOM The Atom whose string is obtained.
lpString LPCSTR* The string corresponding to hAtom. Returns an empty string if hAtom is equal to IG_PDF_ATOM_NULL or NULL if the hAtom has not been defined.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.