DeletePrinterDataEx 関数

DeletePrinterDataEx 関数は、プリンターの構成データから指定した値を削除します。 プリンターの構成データは、レジストリ キーの階層に格納されている名前付き値と型指定された値のセットで構成されます。 関数は、指定したキーの下にある指定した値を削除します。

DeletePrinterData 関数と同様に、DeletePrinterDataEx は SetPrinterData 関数によって格納されている値を削除できます。 さらに、 DeletePrinterDataEx は 、SetPrinterDataEx 関数によって指定されたキーの下に格納されている値を削除できます。

構文

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

パラメーター

hPrinter [in]

関数が値を削除するプリンターへのハンドル。 プリンター ハンドルを取得するには、 OpenPrinter 関数または AddPrinter 関数を使用します。

pKeyName [in]

削除する値を含むキーを指定する null で終わる文字列へのポインター。 区切り記号として円記号 ( \ ) 文字を使用して、1 つ以上のサブキーを持つパスを指定します。

pKeyName が NULL または空の文字列の場合、DeletePrinterDataEx はERROR_INVALID_PARAMETERを返します。

pValueName [in]

削除する値の名前を指定する null で終わる文字列へのポインター。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値はシステム エラー コードです。

注釈

注意

これはブロック関数または同期関数であり、すぐには返されない場合があります。 この関数が返す速度は、アプリケーションの作成時に予測が困難なネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因などの実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
ヘッダー	Winspool.h (Windows.h を含む)
ライブラリ	Winspool.lib
[DLL]	Winspool.drv
Unicode 名と ANSI 名	DeletePrinterDataExW (Unicode) と DeletePrinterDataExA (ANSI)

関連項目

印刷

印刷スプーラー API 関数

DeletePrinterKey

EnumPrinterDataEx

EnumPrinterKey

GetPrinterDataEx

OpenPrinter

SetPrinterDataEx