`pdfGetActionType`

Get the TActionType of an action by its handle.

Category	Actions
Availability	Partial — GoToE/SetOCGState/Movie kinds unmapped — see the chapter note above

Purpose — Get the TActionType of an action by its handle.

Declarations

int32_t __stdcall pdfGetActionType(PPDF IPDF, uint32_t ActHandle);

Delphi

function pdfGetActionType(const IPDF: PPDF; ActHandle: Cardinal): Integer; stdcall; external 'LumasPdf.dll';

TActionType (from Lumas.Pdf.Types; ordinals matter):

Delphi

TActionType = (atGoTo, atGoToR, atHide, atImportData, atJavaScript,
               atLaunch, atMovie, atNamed, atRendition, atReset,
               atSetOCGState, atSound, atSubmit, atThread, atTransition,
               atURI, atGoTo3DView, atGoToE, atRichMediaExec);

Parameters

Parameter	Type	Description
`IPDF`	`PPDF`	Instance handle.
`ActHandle`	`Cardinal`	Action handle from any `pdfCreate*Action` call.

Return value — Ord(TActionType) on success; -1 if ActHandle is out of range, or if the action is a GoToE, SetOCGState, or Movie action (see the chapter-level gap note above).

See also — pdfGetActionTypeEx

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs

public static extern int pdfGetActionType(IntPtr IPDF, uint ActHandle);

Area

Core SDK