NPI_PROVIDER_ATTACH_CLIENT_FN コールバック関数 (netioddk.h)

[アーティクル]
08/07/2023

プロバイダーモジュールの ProviderAttachClient コールバック関数は、プロバイダーモジュールをクライアントモジュールにアタッチします。

構文

NPI_PROVIDER_ATTACH_CLIENT_FN NpiProviderAttachClientFn;

NTSTATUS NpiProviderAttachClientFn(
  [in]  HANDLE NmrBindingHandle,
  [in]  PVOID ProviderContext,
  [in]  PNPI_REGISTRATION_INSTANCE ClientRegistrationInstance,
  [in]  PVOID ClientBindingContext,
  [in]  const VOID *ClientDispatch,
  [out] PVOID *ProviderBindingContext,
  [out] const VOID **ProviderDispatch
)
{...}

パラメーター

[in] NmrBindingHandle

クライアントモジュールとプロバイダーモジュールの間のバインドを表すために、NMR によって使用されるハンドル。

[in] ProviderContext

プロバイダーモジュールの登録コンテキストへのポインター。プロバイダーモジュールは、NmrRegisterProvider 関数を呼び出して自身をNMR に登録するときに、このポインターをNMR に渡します。

[in] ClientRegistrationInstance

へのポインター NPI_REGISTRATION_INSTANCE 構造体。この構造体には、クライアントモジュールの登録データが含まれています。

[in] ClientBindingContext

クライアントモジュールとプロバイダーモジュールの間のバインディングに対するクライアントモジュールのコンテキストへのポインター。クライアントモジュールはこのコンテキストを使用して、バインディングの状態を追跡します。クライアントモジュールのバインドコンテキストの内容は、プロバイダーモジュールに対して不透明です。プロバイダーモジュールは、クライアントモジュールのバインドコンテキストを必要とするクライアントモジュールの NPI コールバック関数を呼び出すたびに、このポインターをクライアントモジュールに渡します。

[in] ClientDispatch

クライアントモジュールの NPI コールバック関数のディスパッチテーブル含む定数構造体へのポインター。構造体の内容は NPI 固有です。 NPI でクライアントディスパッチテーブル構造が定義されていない場合、このポインターは NULL 。

[out] ProviderBindingContext

プロバイダーモジュールがクライアントモジュールとプロバイダーモジュールの間のバインディングのコンテキストへのポインターを格納する変数へのポインター。プロバイダーモジュールでは、このコンテキストを使用して、バインディングの状態を追跡します。プロバイダーモジュールのバインドコンテキストの内容は、クライアントモジュールに対して不透明です。クライアントモジュールは、プロバイダーモジュールのバインドコンテキストを必要とするプロバイダーモジュールの NPI 関数のいずれかを呼び出すたびに、このポインターをプロバイダーモジュールに渡します。プロバイダーモジュールは、クライアントモジュールがプロバイダーモジュールにアタッチされている限り、このコンテキストが有効であり、メモリ内に常駐していることを確認する必要があります。

[out] ProviderDispatch

プロバイダーモジュールが、プロバイダーモジュールの NPI 関数のディスパッチテーブルを含む定数構造体へのポインター格納する変数へのポインター。プロバイダーモジュールは、クライアントモジュールがプロバイダーモジュールに接続されている限り、この構造体が有効であり、メモリ内に常駐していることを確認する必要があります。構造体の内容は NPI 固有です。

戻り値

プロバイダーモジュールの ProviderAttachClient コールバック関数は、次のいずれかの NTSTATUS コードを返します。

リターンコード	形容
STATUS_SUCCESS	プロバイダーモジュールがクライアントモジュールに正常にアタッチされました。
STATUS_NOINTERFACE	プロバイダーモジュールがクライアントモジュールにアタッチされませんでした。
その他の状態コードの	エラーが発生しました。

備考

クライアントモジュールがクライアントモジュールとプロバイダーモジュール間のバインドを表すハンドルを使用してのNmrClientAttachProvider 関数を呼び出すたびに、クライアントモジュールの ProviderAttachClient コールバック関数を呼び出します。

プロバイダーモジュールは、クライアントモジュールの登録データを調べることができます。このデータは、ClientRegistrationInstance パラメーターが指す構造にあります。プロバイダーモジュールは、このデータを使用して、クライアントモジュールにアタッチするかどうかを判断します。

プロバイダーモジュールがクライアントモジュールにアタッチすると判断した場合、ProviderAttachClient コールバック関数は次の操作を行う必要があります。
1. ClientBindingContext で渡されたポインターを保存し、ClientDispatch パラメーターを して、プロバイダーモジュールがクライアントモジュールの NPI 関数を呼び出すことができるようにします。
2. NmrBindingHandle パラメーターに渡されたハンドルを保存します。プロバイダーモジュールは、このハンドルをパラメーターとして NmrProviderDetachClientComplete クライアントモジュールからデタッチするときに機能します。
3. ProviderBindingContext パラメーターを設定して、クライアントモジュールとプロバイダーモジュール間のバインドのプロバイダーモジュールのバインドコンテキスト構造を指すようにします。
4. ProviderDispatch パラメーターを、NPI 関数のプロバイダーモジュールのディスパッチテーブルを含む構造体ポイントするように設定します。
5. STATUS_SUCCESSを返します。
プロバイダーモジュールがクライアントモジュールにアタッチしないと判断した場合、ProviderAttachClient コールバック関数はSTATUS_NOINTERFACEを返す必要があります。

プロバイダーモジュールがクライアントモジュールにアタッチされ、バインドコンテキスト用にメモリが動的に割り当てられた場合、その割り当てられたメモリは、NMR がプロバイダーモジュールを呼び出すときに解放する必要があります。 ProviderCleanupBindingContext クライアントモジュールとプロバイダーモジュールが互いにデタッチされた後のコールバック関数です。

このNMRは、IRQL = PASSIVE_LEVELでプロバイダーモジュールの ProviderAttachClient コールバック関数を呼び出します。

必要条件

要件	価値
サポートされる最小クライアント	Windows Vista 以降のバージョンの Windows オペレーティングシステムで使用できます。
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	netioddk.h (Wsk.h を含む)
IRQL	PASSIVE_LEVEL

次の方法で共有

NPI_PROVIDER_ATTACH_CLIENT_FN コールバック関数 (netioddk.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース