RasGetConnectStatusA 関数 (ras.h)
RasGetConnectStatus 関数は、指定されたリモート アクセス接続の現在の状態に関する情報を取得します。 アプリケーションはこの呼び出しを使用して、非同期 RasDial 呼び出しがいつ完了するかを判断できます。
構文
DWORD RasGetConnectStatusA(
[in] HRASCONN unnamedParam1,
[in, out] LPRASCONNSTATUSA unnamedParam2
);
パラメーター
[in] unnamedParam1
状態を取得するリモート アクセス接続を指定します。 このハンドルは 、RasDial または RasEnumConnections から取得されている必要があります。
[in, out] unnamedParam2
出力時に状態情報を受け取る RASCONNSTATUS 構造体へのポインター。
入力時に、構造体の dwSize メンバーを sizeof(RASCONNSTATUS) に設定して、渡される構造体のバージョンを識別します。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS。
関数が失敗した場合、戻り値は次のいずれかのエラー コードか、 ルーティングとリモート アクセスのエラー コード または Winerror.h からの値です。
| 値 | 意味 |
|---|---|
|
関数は、操作を完了するのに十分なメモリを割り当てませんでした。 |
注釈
RasGetConnectStatus の戻り値が、RasGetConnectStatus によって返される RASCONNSTATUS 構造体の dwError メンバーの値と必ずしも等しいとは限りません。 RasGetConnectStatus の戻り値は RasGetConnectStatus 関数の呼び出し中に発生するエラーを示し、dwError メンバーは接続の確立を妨げるエラーを示します。
注意
ras.h ヘッダーは RasGetConnectStatus をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | ras.h |
| Library | Rasapi32.lib |
| [DLL] | Rasapi32.dll |