ImageGear for C and C++ on Windows v19.6 - Updated
IG_PDF_bookmark_add_subtree
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_BOOKMARK > IG_PDF_bookmark_add_subtree

Adds a copy of the bookmark sub-tree source to hBookmark as a new last child of hBookmark.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_bookmark_add_subtree(
        HIG_PDF_BOOKMARK hBookmark,
        HIG_PDF_BOOKMARK hSubtree,
        LPSTR lpszSourceTitle
);

Arguments:

Name Type Description
hBookmark HIG_PDF_BOOKMARK The bookmark to which the sub-tree source is added as a new last child.
hSubtree HIG_PDF_BOOKMARK The bookmark sub-tree to add.
lpszSourceTitle LPSTR The new bookmark's title.

Remarks:

This new item will have the text value lpszSourceTitle, will be open, and will have no destination attribute. hSubtree must have been previously unlinked. If hBookmark previously had no children, it will be open after the sub-tree is added.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.