API referenceCore SDK

pdfGetMovieAction

Read back a movie action's title and operation.

CategoryActions
NoteLumas extension

Purpose — Read back a movie action's title and operation.

Declarations

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

TPDFMovieAction:

Delphi
TPDFMovieAction = record
  StructSize: Cardinal;
  Title:      PAnsiChar;
  Operation:  Integer;   // 0=Play 1=Stop 2=Pause 3=Resume
end;

Parameters

ParameterTypeDescription
IPDFPPDFInstance handle.
HandleCardinalAction handle from pdfCreateMovieAction.
ActionTPDFMovieAction*Receives Title/Operation. StructSize is not written by this call.

Return valueTRUE if Handle names a Movie (kind 13) action; FALSE otherwise. Recall from E07 that pdfCreateMovieAction is itself a Lumas extension the reference ABI lacks a creator for — this getter is the reference-ABI half of that pairing.

See alsopdfCreateMovieAction

C# (P/Invoke)

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

Getters

Exported names

pdfGetMovieAction

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.