pdfImportPendingAnnots

Purpose — Materialise annotations that a lazy import has deferred, so their handles become available without touching every page yourself.

Description — When a file is imported with the lazy-annotations import flag (if2LazyAnnots) set, per-page annotations are not carried across at import time. This function pumps that deferred work explicitly: it walks the pages that still have pending annotations, in page order, and imports their annotations — so the resulting annotation handles come out exactly as an eager import would have dealt them. Pages whose annotations are already materialised are skipped.

You never have to call it for correctness: any operation that needs the annotations — annotation counts and lookups, page reordering or deletion, saving, closing the import source — pumps the remainder itself. The export exists so a caller can choose *when* the work happens (an idle loop, a background step) and ask how much is left.

MaxPages selects the mode:

Additionally, setting bit 30 (0x40000000) on a non-negative value makes the call non-blocking: if a render is in flight, the function reports instead of waiting for the render locks.

Parameters

Return value — The number of pages still pending after the call, in every mode — 0 means the pump is finished. 0 is also returned for an invalid handle, and for a document imported without if2LazyAnnots, where nothing is ever pending.

Declarations

LPDF_API SI32 PDF_CALL pdfImportPendingAnnots(PPDF IPDF, SI32 MaxPages);

function pdfImportPendingAnnots(const IPDF: PPDF; MaxPages: Integer): Integer; stdcall; external 'LumasPdf.dll';

C# (P/Invoke)

public static extern int pdfImportPendingAnnots(IntPtr IPDF, int MaxPages);