AddPort 関数
AddPort 関数は、サポートされているポートの一覧にポートの名前を追加します。 AddPort 関数は、ポート モニターによってエクスポートされます。
構文
BOOL AddPort(
_In_ LPTSTR pName,
_In_ HWND hWnd,
_In_ LPTSTR pMonitorName
);
パラメーター
-
pName [in]
-
ポートが接続されているサーバーの名前を指定する、0 で終わる文字列へのポインター。 このパラメーターが NULL の場合、ポートはローカルです。
-
hWnd [in]
-
[AddPort] ダイアログ ボックスの親ウィンドウへのハンドル。
-
pMonitorName [in]
-
ポートに関連付けられているモニターを指定する、0 で終わる文字列へのポインター。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合は、0 を返します。
注釈
注意
これはブロック関数または同期関数であり、すぐには返されない可能性があります。 この関数が返す速度は、ネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因など、アプリケーションの作成時に予測が困難な実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。
AddPort 関数は、ネットワークを参照して既存のポートを検索し、ユーザーのダイアログ ボックスを表示します。 AddPort 関数は、 EnumPorts を呼び出してユーザーが入力したポート名を検証し 、 重複する名前が存在しないことを確認する必要があります。
AddPort 関数の呼び出し元は、ポートが接続されているサーバーにSERVER_ACCESS_ADMINISTERアクセスできる必要があります。
ダイアログ ボックスを表示せずにポートを追加するには、AddPort の代わりに XcvData 関数を呼び出します。 XcvData の詳細については、「Microsoft Windows Driver Development Kit (DDK)」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows 2000 Server [デスクトップ アプリのみ] |
| ヘッダー |
|
| ライブラリ |
|
| [DLL] |
|
| Unicode 名と ANSI 名 |
AddPortW (Unicode) と AddPortA (ANSI) |