Fonction AbortDoc (wingdi.h)

  • Article

La fonction AbortDoc arrête le travail d’impression en cours et efface tout ce qui a été dessiné depuis le dernier appel à la fonction StartDoc .

Syntaxe

int AbortDoc(
  [in] HDC hdc
);

Paramètres

[in] hdc

Gérez le contexte de l’appareil pour le travail d’impression.

Valeur retournée

Si la fonction réussit, la valeur de retour est supérieure à zéro.

Si la fonction échoue, la valeur de retour est SP_ERROR.

Remarques

Note 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 l’implémentation du pilote d’imprimante, facteurs 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.
 
Les applications doivent appeler la fonction AbortDoc pour arrêter un travail d’impression si une erreur se produit, ou pour arrêter un travail d’impression après que l’utilisateur a annulé ce travail. Pour terminer une tâche d’impression réussie, une application doit appeler la fonction EndDoc .

Si le Gestionnaire d’impression a été utilisé pour démarrer le travail d’impression, l’appel d’AbortDoc efface l’intégralité du travail de pool, afin que l’imprimante ne reçoive rien. Si le Gestionnaire d’impression n’a pas été utilisé pour démarrer le travail d’impression, les données ont peut-être déjà été envoyées à l’imprimante. Dans ce cas, le pilote d’imprimante réinitialise l’imprimante (si possible) et met fin au travail d’impression.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête wingdi.h (inclure Windows.h)
Bibliothèque Gdi32.lib
DLL Gdi32.dll

Voir aussi

EndDoc

Fonctions API du spouleur d’impression

Impression

SetAbortProc

StartDoc