pdfGetLaunchAction
Read back a Launch action's file name and new-window flag.
| Category | Actions |
|---|
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
BOOL32 __stdcall pdfGetLaunchAction(PPDF IPDF, uint32_t Handle, TPDFLaunchAction* Action);
function pdfGetLaunchAction(const IPDF: PPDF; Handle: Cardinal; var Action: TPDFLaunchAction): LongBool; stdcall; external 'LumasPdf.dll';
TPDFLaunchAction:
TPDFLaunchAction = record
StructSize: Cardinal;
FileName: PAnsiChar;
NewWindow: LongBool;
end;
Parameters
| Parameter | Type | Description |
|---|---|---|
IPDF | PPDF | Instance handle. |
Handle | Cardinal | Action handle from pdfCreateLaunchAction/…Ex. |
Action | TPDFLaunchAction* | Receives FileName/NewWindow. StructSize is not written by this call. |
Return value — TRUE if Handle names a Launch (kind 5) action; FALSE otherwise.
See also — pdfCreateLaunchActionEx
C# (P/Invoke)
[return: MarshalAs(UnmanagedType.Bool)]
Getters
pdfGetLaunchAction
The …A form takes UTF-8, …W
takes UTF-16; a bare name aliases the ANSI form.
Worked examples — complete programs in ten languages.