Partager via


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 [in]

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

pKeyName [in]

Pointeur vers une chaîne terminée par null qui spécifie la clé à supprimer. Utilisez le caractère barre oblique inverse ( \ ) comme délimiteur 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 sous la clé de niveau supérieur de l’imprimante. Si pKeyName a la valeur NULL, DeletePrinterKey retourne ERROR_INVALID_PARAMETER.

Valeur retournée

Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.

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

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.

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
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