WaitForRenderJob

Document inspection, Rendering

Description

Blocks the calling thread until a render job finishes or the timeout elapses, then returns the job's terminal state

Syntax

Delphi

Function TPDFlib.WaitForRenderJob(JobHandle: Integer; TimeoutMS: Integer): Integer;

DLL

int DLWaitForRenderJob(int InstanceID, int JobHandle, int TimeoutMS);

ActiveX

Function PDFlib::WaitForRenderJob(JobHandle As Long, TimeoutMS As Long) As Long

Parameters

JobHandle	The handle returned by `StartRenderPageJob`
TimeoutMS	The maximum wait in milliseconds; 0 returns immediately after a non-blocking check

Return values

1–6	The `RENDER_JOB_STATE_*` code observed when the wait returns
0	The handle is invalid

Remarks

The return value distinguishes completion (RENDER_JOB_STATE_COMPLETED), cancellation (RENDER_JOB_STATE_CANCELLED) and failure (RENDER_JOB_STATE_FAILED) in one call