API referenceCore SDK

pdfGetLaunchAction

Read back a Launch action's file name and new-window flag.

CategoryActions

Purpose — Read back a Launch action's file name and new-window flag.

Description — As documented in pdfCreateLaunchAction, the OS/parameter fields (OP, DefDir, Param) were never stored at creation time, so unsurprisingly this getter has nothing to return for them either — TPDFLaunchAction has no slots for them at all.

Declarations

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

TPDFLaunchAction:

Delphi
TPDFLaunchAction = record
  StructSize: Cardinal;
  FileName:   PAnsiChar;
  NewWindow:  LongBool;
end;

Parameters

ParameterTypeDescription
IPDFPPDFInstance handle.
HandleCardinalAction handle from pdfCreateLaunchAction/…Ex.
ActionTPDFLaunchAction*Receives FileName/NewWindow. StructSize is not written by this call.

Return valueTRUE if Handle names a Launch (kind 5) action; FALSE otherwise.

See alsopdfCreateLaunchActionEx

C# (P/Invoke)

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

Getters

Exported names

pdfGetLaunchAction

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.