RasGetSubEntryHandleA 関数 (ras.h)

[アーティクル]
03/05/2024

RasGetSubEntryHandle 関数は、マルチリンク接続の指定されたサブエントリの接続ハンドルを取得します。

構文

DWORD RasGetSubEntryHandleA(
  [in]  HRASCONN   unnamedParam1,
  [in]  DWORD      unnamedParam2,
  [out] LPHRASCONN unnamedParam3
);

パラメーター

[in] unnamedParam1

マルチリンク電話帳エントリの RasDial 関数によって返される HRASCONN 接続ハンドルを指定します。

[in] unnamedParam2

電話帳エントリの有効なサブエントリインデックスを指定します。

[out] unnamedParam3

サブエントリ接続を表す接続ハンドルを受け取る HRASCONN 変数へのポインター。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS。

関数が失敗した場合、戻り値は次のいずれかのエラーコードか、ルーティングとリモートアクセスのエラーコードまたは Winerror.h からの値です。

値	意味
ERROR_INVALID_HANDLE	hRasConn 接続ハンドルは、接続された電話帳エントリを表していません。
ERROR_PORT_NOT_OPEN	hRasConn パラメーターと dwSubEntry パラメーターは有効ですが、指定されたサブエントリは接続されていません。
ERROR_NO_MORE_ITEMS	dwSubEntry で指定された値が、電話帳エントリのサブエントリの最大数を超えています。

注釈

hRasConn パラメーターで指定された接続ハンドルはマルチリンク接続全体を参照しますが、*lphRasConn パラメーターで返される接続ハンドルはサブエントリ接続のみを参照します。 RasHangUp、RasGetConnectStatus、RasGetProjectionInfoEx 関数など、hRasConn パラメーターを受け取る任意の関数でサブエントリ接続ハンドルを使用します。複数リンクエントリの RasGetProjectionInfo によって返されるプロジェクション情報は、メイン接続ハンドルの場合と同様に、サブエントリの各接続ハンドルで同じです。

RasGetSubEntryHandle によって返されるハンドルで RasHangUp を呼び出して、マルチリンク接続で単一のリンクを終了できます。ただし、 RasGetConnectStatus を使用してリンクが終了したかどうかを判断することはできません。リンクが正常に終了した場合でも 、RasGetConnectStatus はERROR_INVALID_HANDLEを返さない可能性があります。

注意

ras.h ヘッダーは RasGetSubEntryHandle をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	ras.h
Library	Rasapi32.lib
[DLL]	Rasapi32.dll