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 関数を呼び出すたびに、NMR はプロバイダーモジュールの ProviderAttachClient コールバック関数を呼び出します。

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

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

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

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

要件

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