ImageGear for C and C++ on Windows v19.0
IG_PDF_bookmark_find_title
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_BOOKMARK > IG_PDF_bookmark_find_title

Gets the first bookmark whose title is lpTitle.

Declaration:

 
Copy Code 
AT_ERRCOUNT ACCUAPI IG_PDF_bookmark_find_title(
        HIG_PDF_BOOKMARK hBookmark,
        LPSTR lpTitle,
        AT_INT nTitleLen,
        AT_INT nMaxDepth,
        LPHIG_PDF_BOOKMARK lphBookmark
);

Arguments:

Name Type Description
hBookmark HIG_PDF_BOOKMARK The root of the bookmark sub-tree to search.
lpTitle LPSTR The text value for which to search.
nTitleLen AT_INT The length of lpTitle.
nMaxDepth AT_INT The number of sub-tree levels to search, not counting the root level.
  • 0 - Only look at hBookmark, not at any of its children.
  • 1 - Check hBookmark and its children, but not any grandchildren or great grandchildren, and so on.
  • -1 - Check the entire sub-tree.
lphBookmark LPHIG_PDF_BOOKMARK The bookmark with the specified title or NULL if there is no such bookmark.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

 

 

©2017. Accusoft Corporation. All Rights Reserved.

Send Feedback