AbortDoc |
gdi32.dll | Annule l'impression du document |
|---|---|---|
| Windows 9X, NT 3.1+, 2000, XP, 2003, CE 2.0+ | ||
Syntaxe
| int AbortDoc(HDC hdc); |
Paramètres
| Nom | Description |
|---|---|
| hdc | Ce paramètre permet d'indiquer le Handle du contexte d'objet de l'imprimante. |
Retour
| Valeur | Description |
|---|---|
| -1 (SP_ERROR) | Cette valeur permet d'indiquer qu'une erreur s'est produite, dans ce cas il faudrait consulter la fonction GetLastError pour obtenir plus de détails. |
| 1 à 32767 | Ces valeurs permettent d'indiquer que l'opération a réussi. |
Description
Cette fonction permet d'effectuer l'annulation d'une impression d'un document.
Remarques
- Cette fonction est bloquante ou synchrone et pourrait ne pas revenir immédiatement. La rapidité avec laquelle cette fonction revient dépend de facteurs liés à l'exécution, tels que l'état du réseau, la configuration du serveur d'impression et la mise en oeuvre du pilote d'imprimante, facteurs difficiles à prévoir lors de l'écriture d'une application. L'appel de cette fonction à partir d'un processus léger gérant les interactions 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 en cas d'erreur ou pour arrêter un travail d'impression après l'annulation de ce travail par l'utilisateur. Pour terminer un travail d'impression réussi, une application doit appeler la fonction EndDoc.
- Si le gestionnaire d'impression a été utilisé pour démarrer le travail d'impression, l'appel de AbortDoc efface l'intégralité du travail de tampon d'impression, de sorte que l'imprimante ne reçoive rien. Si le gestionnaire d'impression n'a pas été utilisé pour démarrer le travail d'impression, il est possible que les données aient déjà été envoyées à l'imprimante. Dans ce cas, le pilote d'imprimante réinitialise l'imprimante (dans la mesure du possible) et termine le travail d'impression.
Exemple
Voici un exemple d'une utilisation typique de cette fonction :
- #include <windows.h>
- #include <stdlib.h>
- #include <stdio.h>
-
- int main()
- {
- HDC hDC;
- StartDoc(hDC,NULL);
- /* ... */
- if(AbortDoc(hDC) == SP_ERROR) {
- printf("Code d'erreur = %i",GetLastError());
- }
- return 0;
- }
-
Voir également
Langage de programmation - C pour Windows - API de Windows - EndDoc
Articles - Les géants de l'informatique - Microsoft
Dernière mise à jour : Mercredi, le 6 août 2014