Xojo Conferences
MBSOct2019CologneDE

DynaPDF Manual - Page 353

Previous Page 352   Index   Next Page 354

Function Reference
Page 353 of 770
filters can occur but this is unusual. If the file buffer was successfully decompressed the member
Decompressed of the structure TPDFFileSpec is set to true.
Remarks:
The structure TPDFFileSpec contains pointers to the original values of the embedded file. These
values must not be changed or freed in your application.
Return values:
If the function succeeds the return value 1 and the structure TPDFFileSpec is filled with values. If the
function fails the return value is 0.
GetEmbeddedFileCount
Syntax:
SI32 pdfGetEmbeddedFileCount(
const PPDF* IPDF) // Instance pointer
The function returns the number of embedded files available in the PDF file. Note that the number of
embedded files from an external PDF file is available after the PDF file has been imported.
Depending of the used import flags embedded files can be excluded from import. See
SetImportFlags(), or ImportPDFFile() for further information.
GetEmbeddedFileNode
Syntax:
LBOOL pdfGetEmbeddedFileNode(
const IEFN* IEF,
// Pointer of an embedded file node
struct TPDFEmbFileNode* F, // see below
LBOOL Decompress)
// If true, the file will be decompressed
struct TPDFEmbFileNode
{
UI32
StructSize; // Must be set to sizeof(TPDFEmbFileNode).
const char*
Name;
// UTF-8 encoded name. This is usually an ASCII string.
struct TPDFFileSpec EF;
// Embedded file.
IEFN*
NextNode;
// Next node if any.
};
struct TPDFFileSpec
{
char* Buffer;
// Buffer of an embedded file.
UI32 BufSize;
// Buffer size in bytes.
LBOOL Compressed;
// Should be false if Decompress was true.
void* ColItem;
// Pointer to user defined collection item.
char* Name;
// Name of the file specification in the name tree.
LBOOL NameUnicode; // Is Name in Unicode format?
char* FileName;
// File name as 7 bit ASCII string.
LBOOL IsURL;
// If true, FileName contains a URL.
char* UF;
// PDF 1.7. Same as FileName but Unicode is allowed.
LBOOL UFUnicode;
// Is UF in Unicode format?
char* Desc;
// Description.
LBOOL DescUnicode; // Is Desc in Unicode format?
UI32 FileSize;
// Decompressed stream size or zero if not known.
 

Previous topic: GetEmbeddedFile

Next topic: GetFileSpec