DeletePrinterKey 関数
DeletePrinterKey 関数は、指定したプリンターの指定したキーとそのすべてのサブキーを削除します。
構文
DWORD DeletePrinterKey(
_In_ HANDLE hPrinter,
_In_ LPCTSTR pKeyName
);
パラメーター
-
hPrinter [in]
-
関数がキーを削除するプリンターへのハンドル。 プリンター ハンドルを取得するには、 OpenPrinter 関数または AddPrinter 関数を使用します。
-
pKeyName [in]
-
削除するキーを指定する null で終わる文字列へのポインター。 区切り記号として円記号 ( \ ) 文字を使用して、1 つ以上のサブキーを含むパスを指定します。
pKeyName が空の文字列 ("") の場合、DeletePrinterKey はプリンターの最上位キーの下にあるすべてのキーを削除します。 pKeyName が NULL の場合、DeletePrinterKey はERROR_INVALID_PARAMETERを返します。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値はシステム エラー コードです。
注釈
注意
これはブロック関数または同期関数であり、すぐには返されない場合があります。 この関数が返す速度は、アプリケーションの作成時に予測が困難なネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因などの実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows 2000 Server [デスクトップ アプリのみ] |
| ヘッダー |
|
| ライブラリ |
|
| [DLL] |
|
| Unicode 名と ANSI 名 |
DeletePrinterKeyW (Unicode) と DeletePrinterKeyA (ANSI) |