Freigeben über


DeletePrinterDataEx-Funktion

Die DeletePrinterDataEx-Funktion löscht einen angegebenen Wert aus den Konfigurationsdaten für einen Drucker. Die Konfigurationsdaten eines Druckers bestehen aus einem Satz benannter und typisierter Werte, die in einer Hierarchie von Registrierungsschlüsseln gespeichert sind. Die Funktion löscht einen angegebenen Wert unter einem angegebenen Schlüssel.

Wie die DeletePrinterData-Funktion kann DeletePrinterDataEx werte löschen, die von der SetPrinterData-Funktion gespeichert sind. Darüber hinaus kann DeletePrinterDataEx Werte löschen, die unter einem angegebenen Schlüssel von der SetPrinterDataEx-Funktion gespeichert sind.

Syntax

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

Parameter

hPrinter [in]

Ein Handle für den Drucker, für den die Funktion einen Wert löscht. Verwenden Sie die OpenPrinter - oder AddPrinter-Funktion , um einen Druckerhandle abzurufen.

pKeyName [in]

Ein Zeiger auf eine NULL-Zeichenfolge, die den Schlüssel mit dem zu löschenden Wert angibt. Verwenden Sie den umgekehrten Schrägstrich ( \ ) als Trennzeichen, um einen Pfad anzugeben, der mindestens einen Unterschlüssel enthält.

Wenn pKeyNameNULL oder eine leere Zeichenfolge ist, gibt DeletePrinterDataEx ERROR_INVALID_PARAMETER zurück.

pValueName [in]

Ein Zeiger auf eine NULL-Zeichenfolge, die den Namen des zu löschenden Werts angibt.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert ERROR_SUCCESS.

Wenn die Funktion fehlschlägt, ist der Rückgabewert ein Systemfehlercode.

Bemerkungen

Hinweis

Dies ist eine blockierende oder synchrone Funktion und wird möglicherweise nicht sofort zurückgegeben. Wie schnell diese Funktion zurückgibt, hängt von Laufzeitfaktoren wie Netzwerk-status, Druckserverkonfiguration und Druckertreiberimplementierungsfaktoren ab, die beim Schreiben einer Anwendung schwer vorherzusagen sind. Wenn Sie diese Funktion über einen Thread aufrufen, der die Interaktion mit der Benutzeroberfläche verwaltet, kann die Anwendung nicht reagieren.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client)
Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)
Windows 2000 Server [nur Desktop-Apps]
Header
Winspool.h (einschließlich Windows.h)
Bibliothek
Winspool.lib
DLL
Winspool.drv
Unicode- und ANSI-Name
DeletePrinterDataExW (Unicode) und DeletePrinterDataExA (ANSI)

Siehe auch

Drucken

Druckspooler-API-Funktionen

DeletePrinterKey

EnumPrinterDataEx

EnumPrinterKey

GetPrinterDataEx

OpenPrinter

SetPrinterDataEx