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

DynaPDF Manual - Page 415

Previous Page 414   Index   Next Page 416

Function Reference
Page 415 of 750
The function retrieves the properties of a Named action. The member StructSize must be set to
sizeof(TPDFNamedAction) before the function can be called.
If the application does not recognize the name, it shall take no action. Only the first four names are
defined in the PDF specs. All other pre-defined names were seen in PDF files created by Adobe's
Acrobat or Distiller.
Return Values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
GetNameDest
Syntax:
LBOOL pdfGetNamedDest(
const PPDF* IPDF,
// Instance pointer
UI32 Index,
// Array index
struct TPDFNamedDest* Dest) // see below
struct TPDFNamedDest
{
UI32
StructSize;
// Must be set to sizeof(TPDFNamedDest)
const char*
NameA;
// The destination name
const UI16*
NameW;
// The destination name
UI32
NameLen;
// Length in characters
const char*
DestFileA;
// If set, the destination is located in
const UI16*
DestFileW;
// this file
UI32
DestFileLen; // Length in characters
SI32
DestPage;
// Destination page number
struct TPDFRect DestPos;
// Destination position
TDestType
DestType;
// Destination type
};
The function returns the properties of a named destination. The member StructSize must be
initialized to sizeof(TPDFNamedDest) before the function can be called. The structure size is used to
identify different versions of the structure.
The interpretion of the member DestPos depends on the destination type. The different destination
types are described in detail at SetBookmarkDest(). If DestFileA or DestFileW is set then the
destination is located in this PDF file. Only string format is set at time.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
GetNamedDestCount
Syntax:
SI32 pdfGetNamedDestCount(
const PPDF* IPDF) // Instance pointer
The function returns the number of named destinations in the PDF file. The named destinations of an
external PDF file are available after the PDF file was imported.
 

Previous topic: GetNamedAction

Next topic: GetNumberFormatObj