ImageGear for C and C++ on Windows v19.4 - Updated
IG_PDF_basdict_get
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > Basic Objects > HIG_PDF_BASDICT > IG_PDF_basdict_get

Gets the value of the specified key in the specified dictionary.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_basdict_get(
        HIG_PDF_BASOBJ hDictionary,
        HIG_PDF_ATOM hKey,
        LPHIG_PDF_BASOBJ lphObject
);

Arguments:

Name Type Description
hDictionary HIG_PDF_BASOBJ The dictionary or stream from which a value is obtained.
hKey HIG_PDF_ATOM The key whose value is obtained. See the PDF Reference to obtain the names of keys in dictionary objects that are part of standard PDF, such as annotations or page objects.
lphObject LPHIG_PDF_BASOBJ The object associated with the specified key. If key is not present or if its value is null, returns an object of type IG_PDF_BASIC_NULL.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

If called with a stream object instead of a dictionary object, this function gets the value of the specified key from the stream's attributes dictionary.