DynaPDF Manual - Page 299

Previous Page 298   Index   Next Page 300

Function Reference
Page 299 of 787
GetBookmark()
FindBookmark(), FindNextBookmark()
Return values:
If the function succeeds the return value is the remaining number of bookmarks. If the function fails
the return value is a negative error code.
DeleteEmbeddedFile
Syntax:
LBOOL pdfDeleteEmbeddedFile(
const PPDF* IPDF, // Instance pointer
UI32 Handle)
// Embedded file handle or array index.
The function deletes an embedded file. The parameter Handle must be a valid embedded file handle.
Such a handle is a simple array index. GetEmbeddedFileCount() returns the remaining number of
embedded files. If all embedded files should be deleted then delete the files from top to bottom by
decrementing the loop variable. This is faster because it is not required to reorganize the array in
which the files are stored in this case. All handles above the deleted file index become invalid after
the file was deleted.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
DeleteField
Syntax:
SI32 pdfDeleteField(
const PPDF* IPDF, // Instance pointer
UI32 AField)
// Field handle
This function deletes an interactive form field. The parameter AField must be a valid field handle.
If the field is a radio button or group field, the child fields used are also deleted. There is no need to
delete each field separately.
A field is never physically deleted. All field handles are still valid after a field was deleted, but the
"Used" flag of the field is set to false (see GetField() for further information). If a field contained an
action that was not used by another object then the action is also deleted.
Fields can also be deleted by using its name instead of the handle. See DeleteFieldEx() for further
information.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
 

Previous topic: DeleteAnnotationFromPage, DeleteAppEvents, DeleteBookmark

Next topic: DeleteFieldEx, DeleteJavaScripts, DeleteOCGFromAppEvent

Start Chat