DynaPDF Manual - Page 433

Previous Page 432   Index   Next Page 434

Function Reference
Page 433 of 839
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. If the function fails the return value is a negative error code.
SI32 pdfGetDocInfoCount(
const PPDF* IPDF) // Instance pointer
The function returns the number of available document info entries of the currently opened import
file or a negative error code on failure. The document info entries can be enumerated with
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
// 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*.

Previous topic: GetInDocInfo

Next topic: GetInEncryptionFlags, GetInFieldCount, GetInIsCollection, GetInIsEncrypted