API referenceCore SDK

pdfGetResetAction

Read back a Reset-form action's field list and exclude flag.

CategoryActions

Purpose — Read back a Reset-form action's field list and exclude flag.

Description — Note that pdfCreateResetAction has no field-selection parameter — every reset action created through this SDK resets all fields. The Fields/FieldCount/ExcludeFields machinery in this getter reads a per-action field-handle array (FActFields) that only a different code path (field-scoped reset, not exposed by pdfCreateResetAction) would ever populate; for actions created via pdfCreateResetAction, expect Fields=NULL, FieldCount=0, ExcludeFields=FALSE.

Declarations

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

TPDFResetFormAction:

Delphi
TPDFResetFormAction = record
  StructSize:    Cardinal;
  Fields:        PInteger;
  FieldCount:    Cardinal;
  ExcludeFields: LongBool;
end;

Parameters

ParameterTypeDescription
IPDFPPDFInstance handle.
HandleCardinalAction handle from pdfCreateResetAction.
ValueTPDFResetFormAction*Receives the field list; StructSize is written.

Return valueTRUE if Handle names a Reset (kind 8) action; FALSE otherwise.

Memory & buffersValue.Fields, when non-NULL, points at an engine-owned buffer valid until the next call to this function.

See alsopdfCreateResetAction

C# (P/Invoke)

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

Getters

Exported names

pdfGetResetAction

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.