Partager via


DeletePrinterDataEx, fonction

La fonction DeletePrinterDataEx supprime une valeur spécifiée des données de configuration d’une imprimante. Les données de configuration d’une imprimante se composent d’un ensemble de valeurs nommées et typées stockées dans une hiérarchie de clés de Registre. La fonction supprime une valeur spécifiée sous une clé spécifiée.

Comme la fonction DeletePrinterData , DeletePrinterDataEx peut supprimer les valeurs stockées par la fonction SetPrinterData . En outre, DeletePrinterDataEx peut supprimer des valeurs stockées sous une clé spécifiée par la fonction SetPrinterDataEx .

Syntaxe

DWORD DeletePrinterDataEx(
  _In_ HANDLE  hPrinter,
  _In_ LPCTSTR pKeyName,
  _In_ LPCTSTR pValueName
);

Paramètres

hPrinter [in]

Handle de l’imprimante pour laquelle la fonction supprime une valeur. 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é contenant la valeur à supprimer. Utilisez le caractère barre oblique inverse ( \ ) comme délimiteur pour spécifier un chemin qui comporte une ou plusieurs sous-clés.

Si pKeyName a la valeur NULL ou une chaîne vide, DeletePrinterDataEx retourne ERROR_INVALID_PARAMETER.

pValueName [in]

Pointeur vers une chaîne terminée par null qui spécifie le nom de la valeur à supprimer.

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
DeletePrinterDataExW (Unicode) et DeletePrinterDataExA (ANSI)

Voir aussi

Impression

Fonctions API du spouleur d’impression

DeletePrinterKey

EnumPrinterDataEx

EnumPrinterKey

GetPrinterDataEx

OpenPrinter

SetPrinterDataEx