ImageGear for C and C++ on Linux v18.10 - Updated
IG_PDF_doc_get_bookmark
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_DOC > IG_PDF_doc_get_bookmark

Gets the root of the document's bookmark tree.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_doc_get_bookmark(
        HIG_PDF_DOC hDoc,
        LPHIG_PDF_BOOKMARK lphRootBookmark
);

Arguments:

Name Type Description
hDoc HIG_PDF_DOC The document whose root bookmark is obtained.
lphRootBookmark LPHIG_PDF_BOOKMARK The document's root bookmark.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

The lphRootBookmark value is valid even if document's bookmark tree is empty.