IXpsPrintJob::GetJobStatus-Methode (xpsprint.h)

Artikel
08/28/2023

[IXpsPrintJob::GetJobSatus wird nicht unterstützt und kann in Zukunft geändert oder nicht mehr verfügbar sein. ]

Ruft den aktuellen Status des Druckauftrags ab.

Syntax

HRESULT GetJobStatus(
  [out, retval] XPS_JOB_STATUS *jobStatus
);

Parameter

[out, retval] jobStatus

Der aktuelle status des Druckauftrags. Informationen zu den in dieser Struktur zurückgegebenen Daten finden Sie unter XPS_JOB_STATUS.

Rückgabewert

Wenn die Methode erfolgreich ist, gibt sie S_OK zurück. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Hinweise

GetJobStatus kann während der Druckauftragsverarbeitung oder nach Abschluss des Druckauftrags aufgerufen werden. Die in XPS_JOB_STATUS zurückgegebenen Werte stellen den aktuellen Zustand des Druckauftrags zum Zeitpunkt des Aufrufs von GetJobStatus dar, sodass es möglich ist, Zwischenzustände zwischen Aufrufen dieser Methode zu verpassen.

Die Werte von jobStatus.currentDocument und jobStatus.currentPage werden garantiert sequenziell ausgeführt: vom ersten bis zum letzten Dokument und von der ersten Seite bis zur letzten Seite in jedem Dokument.

Die Auftrags-ID eines Druckauftrags, der an den Microsoft XPS Document Writer (MXDW) gesendet wurde, ist 0. Wenn die Schnittstelle die eines Druckauftrags ist, der an die MXDW gesendet wurde, wird null in jobStatus.jobId zurückgegeben.

Wenn dem Druckauftrag keine Auftrags-ID zugewiesen wurde oder der Druckauftrag ohne Spooling gedruckt wird, wird null in jobStatus.jobId zurückgegeben.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 7 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	xpsprint.h