次の方法で共有

RasGetSubEntryHandleA 関数 (ras.h)

  • [アーティクル]

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

構文

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

パラメーター

[in] unnamedParam1

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

[in] unnamedParam2

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

[out] unnamedParam3

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

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのエラー コード、または Routing と Remote Access Error Codes または 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 ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RasGetSubEntryHandle を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件 価値
サポートされる最小クライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされる最小サーバー Windows 2000 Server [デスクトップ アプリのみ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー ras.h
ライブラリ Rasapi32.lib
DLL Rasapi32.dll

関連項目

RasDial

RasGetConnectStatus

RasGetProjectionInfoEx

RasHangUp

リモート アクセス サービス (RAS) の概要

リモート アクセス サービス関数 の