PFN_WSK_CLIENT_EVENT コールバック関数 (wsk.h)
WskClientEvent イベント コールバック関数は、特定のソケットに固有ではないイベントについて WSK アプリケーションに通知します。
構文
PFN_WSK_CLIENT_EVENT PfnWskClientEvent;
NTSTATUS PfnWskClientEvent(
[in, optional] PVOID ClientContext,
[in] ULONG EventType,
[in, optional] PVOID Information,
[in] SIZE_T InformationLength
)
{...}
パラメーター
[in, optional] ClientContext
WskRegister 関数に渡される WskClientNpi パラメーターで指定されたコンテキスト値へのポインター。
[in] EventType
WSK アプリケーションに通知される特定のイベント。 現在、イベントは定義されていません。
[in, optional] Information
イベントに関連付けられている追加情報を含むバッファーへのポインター。 イベントに関連付けられている追加情報がない場合、このポインターは NULL になります。
[in] InformationLength
によって指されるバッファーに含まれる追加情報の長さ。
Information パラメーター。 イベントに関連付けられている追加情報がない場合、この値は 0 になります。
戻り値
WSK アプリケーションの WskClientEvent イベント コールバック関数は、次のいずれかの NTSTATUS コードを返すことができます。
リターン コード | 説明 |
---|---|
|
イベント通知が正常に処理されました。 |
|
Event パラメーターで渡されるイベントのサポートは実装されていません。 |
注釈
現時点では、 WskClientEvent イベント コールバック関数に対してイベントは定義されていません。 したがって、WSK アプリケーションが WskClientEvent イベント コールバック関数を実装する場合は、常に STATUS_NOT_IMPLEMENTEDを返す必要があります。
Information パラメーターによって指されるバッファーに含まれる追加情報は読み取り専用であり、WskClientEvent イベント コールバック関数の呼び出しの期間中のみ有効です。
WSK アプリケーションが WskClientEvent イベント コールバック関数を実装していない場合は、WskRegister を呼び出す前に、WSK_CLIENT_DISPATCH構造体の WskClientEvent メンバーを NULL に設定する必要があります。
WSK サブシステムは、WSK アプリケーションの WskClientEvent イベント コールバック関数を IRQL <= DISPATCH_LEVELで呼び出します。
WSK アプリケーションの WskClientEvent イベント コールバック関数は、WSK 完了関数またはイベント コールバック関数のコンテキストで、他の WSK 要求の完了を待つ必要はありません。 コールバックは、他の WSK 要求を開始できますが (DISPATCH_LEVELで時間がかかりすぎないことを前提とします)、IRQL = PASSIVE_LEVEL でコールバックが呼び出された場合でも、その完了を待つ必要はありません。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista 以降のバージョンの Windows オペレーティング システムで使用できます。 |
対象プラットフォーム | Windows |
ヘッダー | wsk.h (Wsk.h を含む) |
IRQL | <= DISPATCH_LEVEL |