MprAdminInterfaceGetHandle 関数 (mprapi.h)
MprAdminInterfaceGetHandle 関数は、指定されたインターフェイスへのハンドルを取得します。
構文
DWORD MprAdminInterfaceGetHandle(
[in] MPR_SERVER_HANDLE hMprServer,
[in] LPWSTR lpwsInterfaceName,
[out] HANDLE *phInterface,
[in] BOOL fIncludeClientInterfaces
);
パラメーター
[in] hMprServer
この呼び出しを実行するルーターを処理します。 MprAdminServerConnect を呼び出して、このハンドルを取得します。
[in] lpwsInterfaceName
取得するインターフェイスの名前を指定する null で終わる Unicode 文字列へのポインター。
[out] phInterface
lpwsInterfaceName で指定されたインターフェイスへのハンドルを受け取る HANDLE 変数へのポインター。
[in] fIncludeClientInterfaces
関数がクライアント インターフェイスを返すかどうかを指定します。 このパラメーターが FALSE の場合、lpwsInterfaceName で指定された名前のインターフェイスの検索では、ROUTER_IF_TYPE_CLIENT型のインターフェイスは無視されます。 このパラメーターが TRUE で 、指定した名前のインターフェイスが存在する場合、 MprAdminInterfaceGetHandle は ROUTER_IF_TYPE_CLIENT 型のインターフェイスへのハンドルを返します。 ROUTER_IF_TYPE_CLIENT型のインターフェイスがいくつか存在する可能性があるため、返されるハンドルは、lpwsInterfaceName で指定された名前で見つかった最初のインターフェイスを参照します。
戻り値
関数が成功した場合、戻り値は NO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 値 | 説明 |
|---|---|
|
呼び出し元アプリケーションに十分な特権がありません。 |
|
lpwsInterfaceName で指定された名前のインターフェイスは存在しません。 |
|
サーバーに渡されるハンドルは NULL です。 |
|
lpwsInterfaceName は NULL です。 |
要件
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | mprapi.h |
| Library | Mprapi.lib |
| [DLL] | Mprapi.dll |