DeletePrinterKey fonction)

La fonction DeletePrinterKey supprime une clé spécifiée et toutes ses sous-clés pour une imprimante spécifiée.

Syntaxe

DWORD DeletePrinterKey(
  _In_ HANDLE  hPrinter,
  _In_ LPCTSTR pKeyName
);

Paramètres

hPrinter [ dans]

Handle vers l’imprimante pour laquelle la fonction supprime une clé. Utilisez la fonction OpenPrinter ou AddPrinter pour récupérer un handle d’imprimante.

pKeyName [ dans]

Pointeur vers une chaîne se terminant par un caractère null qui spécifie la clé à supprimer. Utilisez la barre oblique inverse ( \ ) comme séparateur pour spécifier un chemin d’accès avec une ou plusieurs sous-clés.

Si pKeyName est une chaîne vide (""), DeletePrinterKey supprime toutes les clés situées sous la clé de niveau supérieur pour l’imprimante. Si pKeyName a la valeur null, DELETEPRINTERKEY retourne un paramètre d’erreur _ non valide _ .

Valeur retournée

Si la fonction réussit, la valeur de retour est une erreur de _ réussite.

Si la fonction échoue, la valeur de retour est un code d’erreur système.

Remarques

Notes

Il s’agit d’une fonction de blocage ou synchrone qui peut ne pas être renvoyée immédiatement. La vitesse à laquelle cette fonction est retournée dépend des facteurs d’exécution tels que l’état du réseau, la configuration du serveur d’impression et les facteurs d’implémentation des pilotes 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 faire que l’application semble ne pas répondre.

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]
En-tête
Winspool. h (inclure Windows. h)
Bibliothèque
Winspool. lib
DLL
Winspool. drv
Noms Unicode et ANSI
DeletePrinterKeyW (Unicode) et DeletePrinterKeyA (ANSI)

Voir aussi

Impression

Fonctions API du spouleur d’impression

DeletePrinterDataEx

EnumPrinterDataEx

EnumPrinterKey

GetPrinterDataEx

OpenPrinter

SetPrinterDataEx