CancelRangeSourcePrefetch

Document management, Progressive loading

Description

Requests cancellation of a prefetch job belonging to the selected range-backed document

Syntax

Delphi

Function TPDFlib.CancelRangeSourcePrefetch(JobHandle: Integer): Integer;

Return value

Returns 1 when the handle is valid, otherwise returns zero and sets LastErrorCode to 401

Remarks

A queued job becomes cancelled immediately and performs no source reads

A running job checks cancellation before dependency-planning rounds and before each source-chunk read

An already executing synchronous source callback cannot be interrupted; cancellation is observed before the next read