DynaPDF Manual - Page 321

Previous Page 320   Index   Next Page 322

Function Reference
Page 321 of 777
Remarks:
This function is implemented in an Ansi and Unicode compatible variant. Bookmarks can be stored
in Unicode or Ansi string format. The function searches always by using both encodings, so that a
bookmark can also be found if the Ansi variant of FindBookmark() was used, but the bookmark was
stored in Unicode or vice versa.
Return values:
If a bookmark can be found the return value is the bookmark handle, a value greater or equal zero. If
no bookmark can be found the return value is -1. If an error occurred, the return value is a negative
error code.
FindEmbeddedFile
Syntax:
SI32 pdfFindEmbeddedFile(
const PPDF* IPDF, // Instance pointer
const char* Name) // Name of the embedded file
The function searches for the embedded file Name and returns the handle of it when it can be found.
The file can then be extracted with GetEmbeddedFile().
Return values:
If the function succeeds the return value is an embedded file handle, a value greater or equal zero. If
the file cannot be found the return value is -1.
FindField
Syntax:
SI32 pdfFindField(
const PPDF* IPDF, // Instance pointer
const char* Name) // Fully qualified field name
This function searches for an interactive form field by using the fully qualified field name. The fully
qualified field name is constructed from the partial field name of the field and all of its ancestors. For
a field with no parent group field, the partial and fully qualified names are the same. For a field that
is the child of another field, the fully qualified name is formed by appending the child field’s partial
name to the parent’s fully qualified name, separated by a period, e.g. "Company.Employee.Name".
Remarks:
Field names are case-sensitive; the name must be specified exactly. This function is available in an
Ansi and Unicode compatible version. Both versions do not depend on the string format in which
the field name is defined, e.g. Unicode or Ansi string.
 

Previous topic: FindBookmark

Next topic: FindLinkAnnot, FindNextBookmark, FinishSignature