RasConnectionNotificationA 関数 (ras.h)

  • [アーティクル]

RasConnectionNotification 関数は、RAS 接続の作成時または終了時にシステムがシグナル状態に設定するイベント オブジェクトを指定します。

構文

DWORD RasConnectionNotificationA(
  [in] HRASCONN unnamedParam1,
  [in] HANDLE   unnamedParam2,
  [in] DWORD    unnamedParam3
);

パラメーター

[in] unnamedParam1

通知を受信する RAS 接続へのハンドル。 これは、 RasDial 関数または RasEnumConnections 関数によって返されるハンドルです。 このパラメーターが INVALID_HANDLE_VALUEの場合、ローカル クライアント上のすべての RAS 接続に関する通知が受信されます。

[in] unnamedParam2

イベント オブジェクトのハンドルを指定します。 CreateEvent 関数を使用して、イベント オブジェクトを作成します。

[in] unnamedParam3

システムが hEvent パラメーターで指定されたイベント オブジェクトを通知する RAS イベントを指定します。 このパラメーターは、次の値の組み合わせです。

値 意味
RASCN_Connection
 hrasconn がINVALID_HANDLE_VALUE場合、RAS 接続の作成時に hEvent が通知されます。
RASCN_Disconnection
 hEvent は、 フラスコン 接続が終了すると通知されます。 hrasconn がマルチリンク接続の場合、すべてのサブエントリが切断されると、イベントが通知されます。 hrasconn がINVALID_HANDLE_VALUE場合、RAS 接続が終了するとイベントが通知されます。
RASCN_BandwidthAdded
 Windows NT: hrasconn が結合されたマルチリンク接続のハンドルである場合、サブエントリが接続されたときに hEvent が通知されます。
RASCN_BandwidthRemoved
 Windows NT: hrasconn が結合されたマルチリンク接続のハンドルである場合、サブエントリが切断されたときに hEvent がシグナル通知されます。

戻り値

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

関数が失敗した場合、戻り値は 、ルーティングおよびリモート アクセス エラー コードまたは Winerror.h からの 0 以外のエラー コードです。

注釈

イベント オブジェクトが通知されるタイミングを確認するには、いずれかの 待機関数を使用します。

イベントが通知されたら、 RasEnumConnections などの他の RAS 関数を使用して、作成または終了された RAS 接続に関する詳細情報を取得します。

注意

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

要件

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

こちらもご覧ください

CreateEvent

RasEnumConnections

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

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