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