GetRenderJobState

Document inspection, Rendering

Description

Returns the current state of a render job without blocking

Syntax

Delphi

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

DLL

int DLGetRenderJobState(int InstanceID, int JobHandle);

ActiveX

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

Parameters

JobHandleThe handle returned by StartRenderPageJob

Return values

1RENDER_JOB_STATE_QUEUED
2RENDER_JOB_STATE_RUNNING
3RENDER_JOB_STATE_PAUSED
4RENDER_JOB_STATE_COMPLETED
5RENDER_JOB_STATE_CANCELLED
6RENDER_JOB_STATE_FAILED
0The handle is invalid

Remarks

Use GetRenderJobResult to read the underlying render outcome after completion or failure