User manual ADOBE ACROBAT SDK 8.1

[. . . ] bc Developing Plug-ins and Applications Adobe® Acrobat® SDK April 2007 Version 8. 1 © 2007 Adobe Systems Incorporated. Adobe® Acrobat® SDK 8. 1 Developing Plug-ins and Applications for Microsoft® Windows®, Mac OS®, Linux® and UNIX® Edition 2. 0, April 2007 If this guide is distributed with software that includes an end user agreement, this guide, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Adobe Systems Incorporated. Please note that the content in this guide is protected under copyright law even if it is not distributed with software that includes an end user license agreement. [. . . ] The following code example retrieves a specific bookmark by invoking the PDDocGetBookmarkRoot method to get the document's root bookmark as a starting point for the search. It then invokes the PDBookmarkGetByTitle method to retrieve the first bookmark whose title matches the specified title. This method requires the following arguments: The root of the bookmark tree that is searched. An ASInt32 object that specifies the number of bookmark levels to search. The value 1 specifies to search only child bookmarks of the current bookmark. The value 0 specifies to look at the current bookmark. Example 9. 5 Retrieving a specific bookmark //Retrieve a bookmark whose title is Samples PDBookmark rootBookmark, myBookmark; char* bookmarkTitle = "Samples"; //Get the root bookmark rootBookmark = PDDocGetBookmarkRoot(myPDDoc); Adobe Acrobat SDK Developing Plug-ins and Applications Working with Bookmarks Retrieving all bookmarks 119 //Retrieve a specific bookmark myBookmark = PDBookmarkGetByTitle (rootBookmark, bookmarkTitle, strlen(bookmarkTitle), -1); if (PDBookmarkIsValid (myBookmark)) AVAlertNote("The bookmark was retrieved"); else AVAlertNote("The bookmark was not retrieved"); Note: In the previous code example, a PDDoc object named myPDDoc is passed to the PDDocGetBookmarkRoot method. For information about creating this object, see "Creating a PDDoc object" on page 83. Retrieving all bookmarks You can use the Acrobat core API to retrieve all bookmarks located within a PDF document. For example, you can retrieve the title of every bookmark that is located within a PDF document. The following code example creates a recursive user-defined function named VisitAllBookmarks. First it invokes the PDBookmarkIsValid method to ensure that the bookmark that is passed is valid (the root bookmark is always valid. ) Second, this user-defined function retrieves the title of the bookmark by invoking the PDBookmarkGetTitle method. This method requires the following arguments: A PDBookmark object that contains the title to retrieve. An ASInt32 object that represents the size of the character pointer. Because the size of the bookmark's title is unknown, the PDBookmarkGetTitle is invoked twice. The first time it is invoked, NULL is passed as the buffer address (second argument) and 0 is specified as the buffer size (third argument). The ASmalloc method is invoked which allocates bufSize bytes to the character pointer. The second time PDBookmarkGetTitle is invoked, the allocated character pointer is passed as well as the ASInt32 object named bufSize. The AVAlertNote method is invoked and the character pointer is passed as an argument that results in the bookmark's title being displayed within a message box. The PDBookmarkHasChildren method is invoked to determine whether there are any child bookmarks under the current bookmark. If there are child bookmarks, the PDBookmarkGetFirstChild method is invoked to retrieve the first child bookmark. A recursive call is made to VisitAllBookmarks (that is, the user-defined method is invoking itself ) until there are no more children bookmarks. Then the PDBookmarkGetNext method is invoked to get a sibling bookmark and the process continues until there are no more bookmarks within the PDF document. Example 9. 6 Retrieving existing bookmarks //Recursively go through bookmark tree to visit each bookmark void VisitAllBookmarks (PDBookmark aBookmark) { PDBookmark treeBookmark; DURING //Ensure that the bookmark is valid Adobe Acrobat SDK Developing Plug-ins and Applications Working with Bookmarks Deleting bookmarks 120 if (!PDBookmarkIsValid(aBookmark)) E_RTRN_VOID //Get the title of the bookmark char * bmBuf; ASInt32 bufSize = PDBookmarkGetTitle(aBookmark, NULL, 0) +1; //Allocate the size of bufSize to the character pointer bmBuf = (char*)ASmalloc((os_size_t)bufSize); //Populate bmBuf with the bookmark's title PDBookmarkGetTitle(aBookmark, bmBuf, bufSize); //Display the title of the bookmark within a message box AVAlertNote(bmBuf); //Determine if the current bookmark has children bookmark if (PDBookmarkHasChildren (aBookmark)) { //Get the first child of the bookmark treeBookmark = PDBookmarkGetFirstChild(aBookmark); while (PDBookmarkIsValid (treeBookmark)){ VisitAllBookmarks (treeBookmark); treeBookmark = PDBookmarkGetNext(treeBookmark); } } HANDLER END_HANDLER } Deleting bookmarks You can use the Acrobat core API to delete an existing bookmark. Deleting a bookmark deletes child bookmarks; however, PDF document content is not affected. To delete a bookmark, you must invoke the PDBookmarkDestroy method and pass a PDBookmark object that represents the bookmark to delete. [. . . ] The path may be specified in relative or absolute form. Creating the public and private keys To create public and private keys, perform the following tasks: 1. Run the Makekey. exe program. Enter a random seed value at the prompt. This can be any string of alphanumeric characters, up to 126 characters in length, with no white space. The size of the public/private key pair varies, but should be between 446 to 448 bytes. [. . . ]