DeletePort 関数
DeletePort 関数は、ユーザーがポート名を削除できるようにするダイアログ ボックスを表示します。
構文
BOOL DeletePort(
_In_ LPTSTR pName,
_In_ HWND hWnd,
_In_ LPTSTR pPortName
);
パラメーター
-
pName [in]
-
ポートを削除するサーバーの名前を指定する、0 で終わる文字列へのポインター。 このパラメーターが NULL の場合、ローカル ポートは削除されます。
-
hWnd [in]
-
ポート削除ダイアログ ボックスの親ウィンドウへのハンドル。
-
pPortName [in]
-
削除する必要があるポートの名前を指定する、0 で終わる文字列へのポインター。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合は、0 を返します。
注釈
注意
これはブロック関数または同期関数であり、すぐには返されない場合があります。 この関数が返す速度は、アプリケーションの作成時に予測が困難なネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因などの実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。
アプリケーションは、 EnumPorts 関数を呼び出すことによって、有効なポートの名前を取得できます。
プリンターが現在指定されたポートに接続されている場合、 DeletePort 関数はエラーを返します。
DeletePort 関数の呼び出し元は、ポートが接続されているサーバーにSERVER_ACCESS_ADMINISTERアクセスできる必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows 2000 Server [デスクトップ アプリのみ] |
| ヘッダー |
|
| ライブラリ |
|
| [DLL] |
|
| Unicode 名と ANSI 名 |
DeletePortW (Unicode) と DeletePortA (ANSI) |