EVT_WDF_DEVICE_PROCESS_QUERY_INTERFACE_REQUEST コールバック関数 (wdfqueryinterface.h)

[KMDF にのみ適用]

ドライバーの EvtDeviceProcessQueryInterfaceRequest イベント コールバック関数は、フレームワークが要求するドライバーにインターフェイスを渡す前に、ドライバー定義インターフェイスへのアクセスに対する別のドライバーの要求を調べます。

構文

EVT_WDF_DEVICE_PROCESS_QUERY_INTERFACE_REQUEST EvtWdfDeviceProcessQueryInterfaceRequest;

NTSTATUS EvtWdfDeviceProcessQueryInterfaceRequest(
  [in]      WDFDEVICE Device,
  [in]      LPGUID InterfaceType,
  [in, out] PINTERFACE ExposedInterface,
  [in, out] PVOID ExposedInterfaceSpecificData
)
{...}

パラメーター

[in] Device

フレームワーク デバイス オブジェクトへのハンドル。

[in] InterfaceType

ドライバー定義インターフェイスを識別する GUID へのポインター。

[in, out] ExposedInterface

ドライバー定義インターフェイスを記述し、インターフェイスへのアクセスを要求しているドライバーによって提供された INTERFACE 構造体へのポインター。

[in, out] ExposedInterfaceSpecificData

追加の省略可能なドライバー定義のインターフェイス固有の情報へのポインター。 フレームワーク ベースのドライバーでは、WdfFdoQueryForInterface を呼び出すときに NULL 以外の InterfaceSpecificData パラメーター値を指定することで、この値を指定します。

戻り値

EvtDeviceProcessQueryInterfaceRequest コールバック関数がサポートする GUID を受け取り、エラーが発生しない場合は、NT_SUCCESS(status) が TRUE に等しいSTATUS_SUCCESSまたは別の状態値を返す必要があります。 フレームワークは引き続きスタックに要求を渡して、追加のドライバーも インターフェイスをサポートしているかどうかを確認します。

EvtDeviceProcessQueryInterfaceRequest コールバック関数は、特定のケースではインターフェイスにサービスを提供しないと判断した場合、STATUS_NOT_SUPPORTEDを返す必要があります。 フレームワークは引き続きスタックに要求を渡して、別のドライバーがインターフェイスをサポートしているかどうかを確認します。 この状況の詳細については、次の「備考」セクションを参照してください。

コールバック関数でエラーが発生した場合は、NT_SUCCESS(status) が FALSE状態値を返す必要があります。 フレームワークは、インターフェイスに対する他のドライバーの要求に失敗し、要求をスタックに渡しません。

注釈

フレームワーク ベースのドライバーは、WdfDeviceAddQueryInterface を呼び出して EvtDeviceProcessQueryInterfaceRequest イベント コールバック関数を登録します。

ドライバー定義インターフェイスが一方向の通信のみをサポートし、インターフェイスを記述するWDF_QUERY_INTERFACE_CONFIG構造体の ImportInterface メンバーを FALSE に設定する場合、EvtDeviceProcessQueryInterfaceRequest コールバック関数は省略可能です。 別のドライバーが WdfFdoQueryForInterface を呼び出すと、フレームワークはドライバー定義のインターフェイス値を要求しているドライバーの INTERFACE 構造体にコピーし、コールバック関数を呼び出します。 一方向通信の場合、コールバック関数を提供する必要があるのは、ドライバーが要求するドライバーに返される前に、ドライバーがインターフェイス値を調べて変更する場合にのみ必要です。

ドライバーが双方向通信をサポートするインターフェイスを定義している場合 (また、WDF_QUERY_INTERFACE_CONFIG構造体の ImportInterface メンバーを TRUE に設定する場合)、ドライバーは EvtDeviceProcessQueryInterfaceRequest イベント コールバック関数を提供する必要があります。 ImportInterfaceTRUE で、別のドライバーが WdfFdoQueryForInterface を呼び出す場合、フレームワークはドライバー定義インターフェイスを要求元のドライバーのインターフェイス構造にコピーしないため、コールバック関数が必要です。 代わりに、コールバック関数は、要求するドライバーのインターフェイス構造を更新する必要があります。

コールバック関数はインターフェイスを変更できます。 特に、次のことができます。

  • インターフェイスの任意のメンバー内の任意の値を変更します。
  • INTERFACE 構造体の Context メンバーを変更して、動的インスタンス固有のコンテキストを割り当てます。
フレームワークは、ドライバーが WdfDeviceAddQueryInterface を呼び出して登録した GUID に対してのみ、ドライバーの EvtDeviceProcessQueryInterfaceRequest コールバック関数を呼び出します。 したがって、これらのコールバック関数は、予期しない GUID を報告するためにSTATUS_NOT_SUPPORTED戻り値を使用しません。 代わりに、 EvtDeviceProcessQueryInterfaceRequest コールバック関数は、特定のケースではインターフェイスを処理しないと判断したときに、STATUS_NOT_SUPPORTEDを返す必要があります。 たとえば、要求元のドライバーが提供するデータに基づいて、ドライバーは、下位レベルのドライバーがインターフェイス要求を処理する必要があると判断する場合があります。 STATUS_NOT_SUPPORTED戻り値は、ドライバーがインターフェイス要求を処理していないが、下位レベルのドライバーがサービスを提供する可能性があることをフレームワークに通知します。

ドライバー定義インターフェイスの詳細については、「 Driver-Defined インターフェイスの使用」を参照してください。

EvtDeviceProcessQueryInterfaceRequest コールバック関数を定義するには、まず、定義するコールバック関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバー、静的ドライバー検証ツール (SDV)、およびその他の検証ツールのコード分析でエラーが検出され、Windows オペレーティング システム用のドライバーを記述するための要件になります。

たとえば、MyDeviceProcessQueryInterfaceRequest という名前の EvtDeviceProcessQueryInterfaceRequest コールバック関数を定義するには、次のコード例に示すように、EVT_WDF_DEVICE_PROCESS_QUERY_INTERFACE_REQUEST型を使用します。

EVT_WDF_DEVICE_PROCESS_QUERY_INTERFACE_REQUEST  MyDeviceProcessQueryInterfaceRequest;

次に、コールバック関数を次のように実装します。

_Use_decl_annotations_
NTSTATUS
 MyDeviceProcessQueryInterfaceRequest (
    WDFDEVICE  Device,
    LPGUID  InterfaceType,
    PINTERFACE  ExposedInterface,
    PVOID  ExposedInterfaceSpecificData
    )
  {...}

EVT_WDF_DEVICE_PROCESS_QUERY_INTERFACE_REQUEST関数の種類は、WdfQueryInterface.h ヘッダー ファイルで定義されています。 コード分析ツールを実行するときにエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のEVT_WDF_DEVICE_PROCESS_QUERY_INTERFACE_REQUEST関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「 KMDF ドライバーの関数ロール型を使用した関数の宣言」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

要件
対象プラットフォーム ユニバーサル
最小 KMDF バージョン 1.0
Header wdfqueryinterface.h (Wdf.h を含む)
IRQL PASSIVE_LEVEL

こちらもご覧ください

インターフェイス

WDF_QUERY_INTERFACE_CONFIG

WdfDeviceAddQueryInterface

WdfFdoQueryForInterface