API referenceCore SDK

pdfSetProgressProc

Register callbacks to report long-running-operation progress

C
BOOL32 __stdcall pdfSetProgressProc(PPDF IPDF, void* Data, TInitProgressProc InitProgress, TProgressProc Progress);
Delphi
function pdfSetProgressProc(const IPDF: PPDF; Data: Pointer; InitProgress: TInitProgressProc; Progress: TProgressProc): LongBool; stdcall;

Purpose. Register callbacks to report long-running-operation progress (e.g. during page rendering or document optimization).

Description. Verified write-only no-op. SetProgressProcH stores Data/InitProgress/Progress into FProgressData/ FProgressInitProc/FProgressProc; these three fields have exactly their declaration, the constructor's nil initialization, and this setter as their only references — none of the three registered callbacks is ever actually invoked anywhere in the codebase. No operation in this SDK reports progress through this mechanism regardless of what is registered.

Parameters.

ParameterDescription
IPDFDocument handle.
DataStored but never passed to any callback invocation.
InitProgress, ProgressStored but never invoked.

Return value. True if IPDF is valid.

Remarks. Despite the ABI shape strongly implying a working progress- reporting mechanism (matching the classic API's documented behavior for long operations), no such reporting occurs in this engine — do not rely on these callbacks firing.

C# (P/Invoke)

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

Setters

Exported names

pdfSetProgressProc

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.