API referenceCore SDK

pdfGetURIAction

Read back a URI action's target.

CategoryActions

Purpose — Read back a URI action's target.

Declarations

C
BOOL32 __stdcall pdfGetURIAction(PPDF IPDF, uint32_t Handle, TPDFURIAction* Action);
Delphi
function pdfGetURIAction(const IPDF: PPDF; Handle: Cardinal; var Action: TPDFURIAction): LongBool; stdcall; external 'LumasPdf.dll';

TPDFURIAction:

Delphi
TPDFURIAction = record
  StructSize:     Cardinal;
  BaseURL:        PAnsiChar;    // always nil in this build
  IsMap:          LongBool;     // always False in this build
  URI:            PAnsiChar;
  NextAction:     Integer;      // always -1 in this build
  NextActionType: TActionType;  // meaningless while NextAction = -1
end;

Parameters

ParameterTypeDescription
IPDFPPDFInstance handle.
HandleCardinalAction handle from pdfCreateURIAction.
ActionTPDFURIAction*Receives URI; StructSize is written; BaseURL/IsMap/NextAction are placeholders — see the record comments.

Return valueTRUE if Handle names a URI (kind 3) action; FALSE otherwise.

See alsopdfCreateURIAction

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
[return: MarshalAs(UnmanagedType.Bool)]
Area
Core SDK
Category

Getters

Exported names

pdfGetURIAction

String variants

The …A form takes UTF-8, …W takes UTF-16; a bare name aliases the ANSI form.

See working code

Worked examples — complete programs in ten languages.