pdfGetResetAction
Read back a Reset-form action's field list and exclude flag.
| Category | Actions |
|---|
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
BOOL32 __stdcall pdfGetResetAction(PPDF IPDF, uint32_t Handle, TPDFResetFormAction* Value);
function pdfGetResetAction(const IPDF: PPDF; Handle: Cardinal; var Value: TPDFResetFormAction): LongBool; stdcall; external 'LumasPdf.dll';
TPDFResetFormAction:
TPDFResetFormAction = record
StructSize: Cardinal;
Fields: PInteger;
FieldCount: Cardinal;
ExcludeFields: LongBool;
end;
Parameters
| Parameter | Type | Description |
|---|---|---|
IPDF | PPDF | Instance handle. |
Handle | Cardinal | Action handle from pdfCreateResetAction. |
Value | TPDFResetFormAction* | Receives the field list; StructSize is written. |
Return value — TRUE if Handle names a Reset (kind 8) action; FALSE otherwise.
Memory & buffers — Value.Fields, when non-NULL, points at an engine-owned buffer valid until the next call to this function.
See also — pdfCreateResetAction
C# (P/Invoke)
[return: MarshalAs(UnmanagedType.Bool)]
Getters
pdfGetResetAction
The …A form takes UTF-8, …W
takes UTF-16; a bare name aliases the ANSI form.
Worked examples — complete programs in ten languages.