PrlJob_GetProgress Function

Obtains a job progress report.

Syntax

PRL_RESULT PrlJob_GetProgress(
    PRL_HANDLE hJob, 
    PRL_UINT32_PTR percentage
);

percentage

[out] A pointer to a variable that receives the result (an integer value from 0 to 100).

handle

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

The job progress is reported as percentage of completion.