PauseRenderJob

Document inspection, Rendering

Description

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

The renderer waits on the job's manual-reset pause gate between operators, so the worker thread parks without giving up; cancel stays observable while paused

Syntax

Delphi

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

DLL

int DLPauseRenderJob(int InstanceID, int JobHandle);

ActiveX

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

Parameters

JobHandleThe handle returned by StartRenderPageJob

Return values

1The pause request was accepted
0The handle is invalid

Remarks

Resume a paused job with ResumeRenderJob; cancelling a paused job releases the gate so it can exit