ImageGear for C and C++ on Linux - Updated
IG_PDF_dictionary_create
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_DICTIONARY > IG_PDF_dictionary_create

Creates a new optional-content membership dictionary object in the given document for the given layers and visibility policy.

Declaration:

 
Copy Code
IG_PDF_dictionary_create(
        HIG_PDF_DOC hDoc,
        LPHIG_PDF_LAYER hLayers,
        AT_INT nLayersCount,
        AT_INT policy, 
        LPHIG_PDF_DICTIONARY lphDictionary
);

Arguments:

Name Type Description
hDoc HIG_PDF_DOC The document in which the dictionary is used.
hLayers LPHIG_PDF_LAYER Array of layers to be the members of the dictionary.
nLayersCount AT_INT The number of layers.
policy AT_INT The visibility policy that determines the visibility of content with respect to the ON/OFF state of the layers listed in the dictionary.
lphDictionary LPHIG_PDF_DICTIONARY The newly created dictionary object.

Return Value:

The newly created dictionary object, or NULL if no layers are supplied.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

To add layer to the existing dictionary, get the current layers' list, modify it, and then create a new dictionary with the new list of layers.