DeletePrinterData, fonction

La fonction DeletePrinterData supprime les données de configuration spécifiées pour une imprimante. Les données de configuration d’une imprimante se composent d’un ensemble de valeurs nommées et typées. La fonction DeletePrinterData supprime l’une de ces valeurs, spécifiées par son nom de valeur.

Appeler DeletePrinterData revient à appeler la fonction DeletePrinterDataEx avec le paramètre pKeyName défini sur « PrinterDriverData ».

Syntaxe

DWORD DeletePrinterData(
  _In_ HANDLE hPrinter,
  _In_ LPTSTR pValueName
);

Paramètres

hPrinter [in]

Handle de l’imprimante dont les données de configuration doivent être supprimées. Utilisez la fonction OpenPrinter ou AddPrinter pour récupérer un handle d’imprimante.

pValueName [in]

Pointeur vers le nom terminé par null de la valeur de données de configuration à 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
DeletePrinterDataW (Unicode) et DeletePrinterDataA (ANSI)

Voir aussi

Impression

Fonctions API du spouleur d’impression

EnumPrinterData

GetPrinterData

OpenPrinter

SetPrinter

SetPrinterData