Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

DynaPDF Manual - Page 389

Previous Page 388   Index   Next Page 390

Function Reference
Page 389 of 750
UI32 Index,
// Entry index
TDocumentInfo ADDR DInfo, // Document info entry type
char* ADDR Key,
// Only set for user defined keys
char* ADDR Value,
// The value of the info entry
LBOOL ADDR Unicode)
// Is value in Unicode format?
The function returns a document info entry from the currently opened import file. The parameter
Index must be a valid index into the array of document info entries. The number of available entries
is returned by GetInDocInfoCount(). The parameter Value holds a pointer to the original value, it
must not be NULL. Do not change or free the value. If the parameter Unicode is true, the value is a
Unicode string. Make a type cast to UI16* in this case. The parameter Key contains always an Ansi
string if set (user defined keys only).
Return values:
If the function succeeds the return value is the string length in characters of the parameter Value.
Depending on the string format make a type cast to UI16*.
GetInEncryptionFlags
Syntax:
SI32 pdfGetInEncryptionFlags(
const PPDF* IPDF) // Instance pointer
The function returns the encryption flags of the currently opened import file. If no flag is set the
return value is zero. To determine whether a PDF file is encrypted call the function
GetInIsEncrypted().
GetInFieldCount
Syntax:
SI32 pdfGetInFieldCount(
const PPDF* IPDF) // Instance pointer
The function returns the number of top level fields included in the currently opened import file. The
number of top level fields may not match the number of fields in the PDF file. For example,
interactive forms created by Adobe's Designer contain usually one top level group field that contains
all other fields of the document. The return value would be 1 in this case because the children of
group fields are not taken into account.
Return values:
If the function succeeds the return value is the number of top level fields, a value greater or equal
zero. If the function fails the return value is a negative error code.
 

Previous topic: GetInDocInfoEx

Next topic: GetInkList