DynaPDF Manual - Page 384

Previous Page 383   Index   Next Page 385

Function Reference
Page 384 of 787
Return values:
If the function succeeds the return value is the field type (make a typecast to TFieldType to
determine the field type). If the function fails the return value is a negative error code.
GetFileSpec
Syntax:
LBOOL pdfGetFileSpec(
const IFSR* IFS,
// Pointer of a file specification
struct TPDFFileSpecEx* F) // see below
struct TPDFFileSpecEx
{
UI32
StructSize;
// Must be set to sizeof(TPDFFileSpecEx).
const char* AFRelationship; // PDF 2.0
const void* ColItem;
// If != NULL the embedded file contains a collection item
// with user defined data. This entry can
// occur in PDF Collections only (PDF 1.7). See chapter
// "PDF Collections" for further information.
const char* DescriptionA;
// Optional description string.
const UI16* DescriptionW;
// Optional description string.
const char* DOS;
// Optional DOS file name.
IEFN*
EmbFileNode;
// -> GetEmbeddedFileNode().
const char* FileName;
// File name as 7 bit ASCII string.
LBOOL
FileNameIsURL;
// If true, FileName contains a URL.
const BYTE* ID1;
// Optional file ID. Meaningful only if FileName points to
// a PDF file. This is a binary string.
UI32
ID1Len;
// String length in bytes.
const BYTE* ID2;
// The file was modified if ID1 and ID2 are different.
UI32
ID2Len;
// String length in bytes.
LBOOL
IsVolatile;
// If true, the file changes frequently with time.
const char* Mac;
// Optional Mac file name.
const char* Unix;
// Optional Unix file name.
IRFN*
RelFileNode;
// Optional related files array. -> GetRelFileNode().
PIMG*
Thumb;
// Optional thumb nail image. -> GetImageObjEx().
const char* UFileNameA;
// PDF 1.7. Same as FileName but Unicode is allowed.
const UI16* UFileNameW;
// Either the Ansi or Unicode string is set but never both.
};
The function retrieves the properties of a file specification. The member StructSize must be set to
sizeof(TPDFFileSpecEx) before the function can be executed.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
GetFillColor
Syntax:
UI32 pdfGetFillColor(
const PPDF* IPDF) // Instance pointer
The function returns the current color used for fillings. The returned color value is not converted to
the active color space. For example, if the color space will be changed with SetColorSpace(), the
color value is still the same. Colors must be correctly defined in the current color space.
Default value = 0 (black)
 

Previous topic: GetFieldTextColor, GetFieldToolTip, GetFieldType

Next topic: GetFont (obsolete)

Start Chat