MprAdminInterfaceConnect 関数 (mprapi.h)
MprAdminInterfaceConnect 関数は、指定された WAN インターフェイスへの接続を作成します。
構文
DWORD MprAdminInterfaceConnect(
[in] MPR_SERVER_HANDLE hMprServer,
[in] HANDLE hInterface,
[in] HANDLE hEvent,
[in] BOOL fSynchronous
);
パラメーター
[in] hMprServer
この呼び出しを実行するルーターを処理します。 MprAdminServerConnect を呼び出して、このハンドルを取得します。
[in] hInterface
インターフェイスへのハンドル。 このハンドルは、 MprAdminInterfaceCreate の以前の呼び出しから取得されます。
[in] hEvent
インターフェイスの接続試行が完了した後に通知されるイベントを処理します。 関数は接続試行を開始し、直ちに を返します。 イベントが通知されたら、 MprAdminInterfaceGetInfo を呼び出して接続試行の結果を取得できます。
このパラメーターが NULL で、 fBlocking が TRUE の場合、この呼び出しは同期的です。つまり、接続試行が完了するまで関数は戻りません。
hMprServer でリモート ルーターが指定されている場合、呼び出し元のアプリケーションはこのパラメーターに NULL を指定する必要があります。
[in] fSynchronous
hEvent が NULL で、このパラメーターが TRUE に設定されている場合、関数は接続の試行が完了するまで戻りません。
hEvent が NULL で、このパラメーターが FALSE に設定されている場合、関数は直ちにを返します。 PENDING の戻り値は、接続試行が正常に開始されたことを示します。
hEvent が NULL でない場合、このパラメーターは無視されます。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 値 | 説明 |
|---|---|
|
呼び出し元アプリケーションに十分な特権がありません。 |
|
このインターフェイスで接続が既に進行中です。 |
|
Demand Dial Manager (DDM) が実行されていません。 |
|
インターフェイスは現在無効になっています。 |
|
このインターフェイスに使用できるアダプターはありません。 |
|
hInterface 値が無効です。 |
|
Demand Dial サービスは現在一時停止しています。 |
|
インターフェイスは接続中です。 hEvent ハンドルが指定されている場合、呼び出し元のアプリケーションは hEvent ハンドルを待機する必要があります。 イベントが通知されたら、 MprAdminInterfaceGetInfo を呼び出すことで、接続の状態と関連するエラーを取得できます。 |
解説
次の表は、 hEvent と fBlocking の関係をまとめたものです。
| hEvent | fBlocking | 結果 |
|---|---|---|
| イベント ハンドル | 無視 | 呼び出しはすぐに戻ります。 PENDING の戻り値は、試行が正常に開始されたことを示します。 hEvent を待機します。 hEvent が通知されたら、MprAdminInterfaceGetInfo を使用して、接続試行の成功または失敗を判断します。 |
| NULL | TRUE | この呼び出しは、接続の試行が完了するまで戻りません。 |
| NULL | FALSE | 呼び出しはすぐに戻ります。 PENDING の戻り値は、試行が正常に開始されたことを示します。 |
要件
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | mprapi.h |
| Library | Mprapi.lib |
| [DLL] | Mprapi.dll |