Xojo Conferences
MBSOct2019CologneDE

DynaPDF Manual - Page 350

Previous Page 349   Index   Next Page 351

Function Reference
Page 350 of 770
}TDocumentInfo;
The function retrieves a document info entry as Unicode string. The parameter Value holds a pointer
to the original Unicode value, it must not be NULL. Do not change or free the value. GetDocInfo()
returns only the values of predefined document info entries. All document info entries, incl. user
defined keys can be accessed with GetDocInfoEx().
Return value:
The return value is the string length in characters. If the info entry is not set it returns 0 and Value is
initialized to NULL.
GetDocInfoCount
Syntax:
SI32 pdfGetDocInfoCount(
const PPDF* IPDF) // Instance pointer
The function returns the number of document info entries defined in the document. This function
can be used in combination with GetDocInfoEx() to enumerate the document info entries of the PDF
file.
GetDocInfoEx
Syntax:
SI32 pdfGetDocInfoEx(
const PPDF* IPDF,
// Instance pointer
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. The parameter Index must be a valid index into the array
of document info entries. The number of available entries is returned by GetDocInfoCount(). 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*.
 

Previous topic: GetDeviceNAttributes, GetDocInfo

Next topic: GetDocUsesTransparency, GetDrawDirection, GetDynaPDFVersion, GetDynaPDFVersionInt