DeletePrinter, fonction

La fonction DeletePrinter supprime l’objet imprimante spécifié.

Syntaxe

BOOL DeletePrinter(
  _Inout_ HANDLE hPrinter
);

Paramètres

hPrinter [in, out]

Handle vers un objet d’imprimante qui sera supprimé. Utilisez la fonction OpenPrinter ou AddPrinter pour récupérer un handle d’imprimante.

Valeur retournée

Si la fonction réussit, la valeur de retour est une valeur différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro.

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.

S’il reste des travaux d’impression à traiter pour l’imprimante spécifiée, DeletePrinter marque l’imprimante pour la suppression en attente, puis la supprime lorsque tous les travaux d’impression ont été imprimés. Aucun travail d’impression ne peut être ajouté à une imprimante marquée pour suppression en attente.

Une imprimante marquée pour suppression en attente ne peut pas être conservée, mais ses travaux d’impression peuvent être conservés, repris et redémarrés. Si l’imprimante est conservée et qu’il existe des travaux pour l’imprimante, DeletePrinter échoue avec ERROR_ACCESS_DENIED.

Notez que DeletePrinter ne ferme pas le handle qui lui est passé. Par conséquent, l’application doit toujours appeler ClosePrinter.

Spécifications

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]
En-tête	Winspool.h (inclure Windows.h)
Bibliothèque	Winspool.lib
DLL	Spoolss.dll

Voir aussi

Impression

Fonctions API du spouleur d’impression

Addprinter

EnumPrinters

OpenPrinter