DynaPDF Manual - Page 442

Previous Page 441   Index   Next Page 443

Function Reference

Page 442 of 860

GetGoToAction

LBOOL pdfGetGoToAction(

const PPDF* IPDF,

// Instance pointer

UI32 Handle,

// Action handle

struct TPDFGoToAction* Action) // see below

struct TPDFGoToAction

{

UI32

StructSize;

// Must be set to sizeof(TPDFGoToAction).

SI32

DestPage;

// Destination page (the first page is denoted by 1).

float*

DestPos;

// Array of 4 floating point values if set.

TDestType

DestType;

// Destination type.

// GoToR (Go To Remote) actions only:

IFSR*

DestFile;

// see GetFileSpec().

const char* DestNameA;

// Optional named destination that shall be loaded when

// opening the file.

const UI16* DestNameW;

// Either the Ansi or Unicode string is set but never both.

SI32

NewWindow;

// Meaningful only if DestFile points to a PDF file.

// -1 = viewer default, 0 = false, 1 = true.

SI32

NextAction;

// -1 or next action handle to be executed if any.

TActionType NextActionType; // Only set if NextAction is >= 0.

};

The function retrieves the properties of a GoTo or GoTo Remote action. The member StructSize

must be set to sizeof(TPDFGoToAction) before the function can be called. The members DestPos and

DestType are not meaningful for GoTo Remote actions.

Return values:

If the function succeeds the return value is 1. If the function fails the return value is 0.

Previous topic: C#, VB 6, VB .Net, PHP, Outline format

Next topic: GetGoToRAction, GetGStateFlags, GetHideAction