`pdfGetGoToRAction`

Read back a GoToR action's target page and destination type.

Category	Actions

The generated R01 skeleton tags this API Stub; the current

implementation is real (GetGoToRActionH reads the action-registry's

GotoPg/Dest fields for kind-4 actions). Trust this chapter over the

Purpose — Read back a GoToR action's target page and destination type.

Description — Reuses the TPDFGoToAction record shape (same as pdfGetGoToAction), but for GoToR this getter fills only DestPage/DestType — the target file name and any named destination set via pdfCreateGoToRActionEx are not exposed through this call at all.

Declarations

BOOL32 __stdcall pdfGetGoToRAction(PPDF IPDF, uint32_t Handle, TPDFGoToAction* Action);

Delphi

function pdfGetGoToRAction(const IPDF: PPDF; Handle: Cardinal; var Action: TPDFGoToAction): LongBool; stdcall; external 'LumasPdf.dll';

Parameters

Parameter	Type	Description
`IPDF`	`PPDF`	Instance handle.
`Handle`	`Cardinal`	Action handle from a `pdfCreateGoToRAction…` call.
`Action`	`TPDFGoToAction*`	Receives `DestPage`/`DestType` only; `DestPos` is not populated by this getter.

Return value — TRUE if Handle names a GoToR (kind 4) action; FALSE otherwise.

Remarks — There is no dedicated getter in this build for the target file name or named destination of a GoToR action; both are write-only through the V17/V03 creators.

See also — pdfCreateGoToRAction

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs

[return: MarshalAs(UnmanagedType.Bool)]

Area

Core SDK