`pdfGetHideAction`

Read back a Hide action's hide/show flag.

Category	Actions
Availability	Partial — field-list not exposed

The generated R05 skeleton tags this API Stub; the current

Purpose — Read back a Hide action's hide/show flag.

Description — Fills Action.Hide from the stored flag. Action.FieldsCount is hardcoded to 1 (the single field handle passed at creation) and Action.Fields is always NULL — the field handle itself is not exposed through this record; this engine does not track a PIFLD array for hide actions.

Declarations

BOOL32 __stdcall pdfGetHideAction(PPDF IPDF, uint32_t Handle, TPDFHideAction* Action);

Delphi

function pdfGetHideAction(const IPDF: PPDF; Handle: Cardinal; var Action: TPDFHideAction): LongBool; stdcall; external 'LumasPdf.dll';

TPDFHideAction:

Delphi

TPDFHideAction = record
  StructSize:  Cardinal;
  Fields:      PIFLD;      // always nil in this build
  FieldsCount: Cardinal;   // always 1 in this build
  Hide:        LongBool;
end;

Parameters

Parameter	Type	Description
`IPDF`	`PPDF`	Instance handle.
`Handle`	`Cardinal`	Action handle from `pdfCreateHideAction`.
`Action`	`TPDFHideAction*`	Receives `Hide`; `Fields`/`FieldsCount` are placeholders — see Description.

Return value — TRUE if Handle names a Hide (kind 6) action; FALSE otherwise.

See also — pdfCreateHideAction

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs

[return: MarshalAs(UnmanagedType.Bool)]

Area

Core SDK