CancelRenderJob

Document inspection, Rendering

Description

Asks a running or paused render job to abort its page at the next content-stream operator boundary

The renderer observes the cancel flag between operators, exits its loop cleanly, and the job ends in the cancelled state; a paused job is released from its gate first so it can observe the flag

Syntax

Delphi

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

DLL

int DLCancelRenderJob(int InstanceID, int JobHandle);

ActiveX

Function PDFlib::CancelRenderJob(JobHandle As Long) As Long

Parameters

JobHandle	The handle returned by `StartRenderPageJob`

Return values

1	The cancel request was accepted
0	The handle is invalid

Remarks

After cancellation GetRenderJobState reports RENDER_JOB_STATE_CANCELLED