ReportJobProcessingProgress function

Article
01/07/2021

Reports to the Print Spooler service whether an XPS print job is in the spooling or the rendering phase and what part of the processing is currently underway.

Syntax

HRESULT ReportJobProcessingProgress(
  _In_ HANDLE                printerHandle,
  _In_ ULONG                 jobId,
       EPrintXPSJobOperation jobOperation,
       EPrintXPSJobProgress  jobProgress
);

Parameters

printerHandle [in]: A printer handle for which the function is to retrieve information. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.
jobId [in]: Identifies the print job for which to retrieve data. Use the AddJob function or StartDoc function to get a print job identifier.
jobOperation: Specifies whether the job is in the spooling phase or the rendering phase.
jobProgress: Specifies what part of the processing is currently underway. This value refers to events in either the spooling or rendering phase depending on the value of jobOperation.

Return value

If the operation succeeds, the return value is S_OK, otherwise the HRESULT will contain an error code.

For more information about COM error codes, see Error Handling.

Remarks

Note

This is a blocking or synchronous function and might not return immediately. How quickly this function returns depends on run-time factors such as network status, print server configuration, and printer driver implementation factors that are difficult to predict when writing an application. Calling this function from a thread that manages interaction with the user interface could make the application appear to be unresponsive.

Note

ReportJobProcessingProgress will only report the progress of the XPS print job if the print job is in the spooling or rendering phase. ReportJobProcessingProgress will fail if it is called when the XPS print job is not in the spooling or rendering phase.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Header	Winspool.h (include Windows.h)
Library	Winspool.lib
DLL	Spoolss.dll