Fonction ReportJobProcessingProgress

Indique au service Spouleur d’impression si un travail d’impression XPS est en cours de mise en file d’attente ou de rendu et quelle partie du traitement est en cours.

Syntaxe

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

Paramètres

printerHandle [in]

Handle d’imprimante pour lequel la fonction doit récupérer des informations. Utilisez la fonction OpenPrinter ou AddPrinter pour récupérer un handle d’imprimante.

jobId [in]

Identifie le travail d’impression pour lequel récupérer des données. Utilisez la fonction AddJob ou la fonction StartDoc pour obtenir un identificateur de travail d’impression.

jobOperation

Spécifie si le travail est en phase de mise en file d’attente ou de rendu.

jobProgress

Spécifie la partie du traitement en cours. Cette valeur fait référence aux événements de la phase de mise en pool ou de rendu en fonction de la valeur de jobOperation.

Valeur retournée

Si l’opération réussit, la valeur de retour est S_OK, sinon le HRESULT contiendra un code d’erreur.

Pour plus d’informations sur les codes d’erreur COM, consultez Gestion des erreurs.

Notes

Notes

Il s’agit d’une fonction bloquante ou synchrone qui peut ne pas être retournée immédiatement. La rapidité avec laquelle cette fonction retourne dépend de facteurs d’exécution tels que l’status réseau, la configuration du serveur d’impression et les facteurs d’implémentation du pilote d’imprimante qui sont difficiles à prédire lors de l’écriture d’une application. L’appel de cette fonction à partir d’un thread qui gère l’interaction avec l’interface utilisateur peut donner l’impression que l’application ne répond pas.

Notes

ReportJobProcessingProgress signale la progression du travail d’impression XPS uniquement si le travail d’impression est en phase de mise en file d’attente ou de rendu. ReportJobProcessingProgress échoue s’il est appelé lorsque le travail d’impression XPS n’est pas en phase de mise en file d’attente ou de rendu.

Spécifications

Condition requise Valeur
Client minimal pris en charge
Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge
Windows Server 2008 [applications de bureau uniquement]
En-tête
Winspool.h (inclure Windows.h)
Bibliothèque
Winspool.lib
DLL
Spoolss.dll

Voir aussi

Impression

Fonctions API du spouleur d’impression

EPrintXPSJobOperation

EPrintXPSJobProgress