ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / PDF Component API Reference / PDF Component Objects Reference / General Objects / HIG_PDF_LAYER / IG_PDF_layer_get_usage_info
In This Topic
    IG_PDF_layer_get_usage_info
    In This Topic

    This function gets usage information from a layer object.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_PDF_layer_get_usage_info(
            HIG_PDF_LAYER hLayer,
            HIG_PDF_ATOM hUsageKey,
            LPHIG_PDF_BASOBJ lphUsageInfo
    );
    

    Arguments:

    Name Type Description
    hLayer HIG_PDF_LAYER Layer object whose usage information is obtained.
    hUsageKey HIG_PDF_ATOM The usage key in the usage dictionary entry. Possible key values are:
    • CreatorInfo
    • Language
    • Export
    • Zoom
    • Print
    • View
    • User
    • PageElement
    lphUsageInfo LPHIG_PDF_BASOBJ The usage information associated with the given key in the Usage dictionary for the layer, or a NULL if the operation fails (because the layer is malformed or has no dictionary, or because the dictionary has no entry corresponding to the given key).

    Return Value:

    Error count.

    Supported Raster Image Formats:

    This function does not process image pixels.

    Remarks:

    A Usage dictionary entry provides more specific intended usage information than an intent entry.