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

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

[in, out] ExposedInterfaceSpecificData

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

戻り値

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

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 イベント コールバック関数 提供する必要があります。 ImportInterface が TRUE され、別のドライバーが WdfFdoQueryForInterface呼び出した場合、フレームワークはドライバー定義インターフェイスを要求元のドライバーのインターフェイス構造にコピーしないため、コールバック関数が必要です。 代わりに、コールバック関数は、要求するドライバーのインターフェイス構造を更新する必要があります。

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

  • インターフェイスの任意のメンバー内の任意の値を変更します。
  • INTERFACE 構造体の Context メンバーを変更して、動的インスタンス固有のコンテキストを割り当てます。
フレームワークは、ドライバーの EvtDeviceProcessQueryInterfaceRequest コールバック関数を呼び出します。このコールバック関数は、WdfDeviceAddQueryInterface呼び出すことによってドライバーが登録した GUID に対してのみ行われます。 したがって、これらのコールバック関数は、予期しない 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
ヘッダー wdfqueryinterface.h (Wdf.h を含む)
IRQL PASSIVE_LEVEL

関連項目

インターフェイスの

WDF_QUERY_INTERFACE_CONFIG

WdfDeviceAddQueryInterface の

WdfFdoQueryForInterface の