EVT_WDF_WMI_INSTANCE_QUERY_INSTANCE コールバック関数 (wdfwmi.h)

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

[KMDF にのみ適用]

ドライバーの EvtWmiInstanceQueryInstance コールバック関数は、WMI プロバイダーのインスタンスデータを WMI クライアントに配信するためのバッファーにコピーします。

構文

EVT_WDF_WMI_INSTANCE_QUERY_INSTANCE EvtWdfWmiInstanceQueryInstance;

NTSTATUS EvtWdfWmiInstanceQueryInstance(
  [in]  WDFWMIINSTANCE WmiInstance,
  [in]  ULONG OutBufferSize,
  [in]  PVOID OutBuffer,
  [out] PULONG BufferUsed
)
{...}

パラメーター

[in] WmiInstance

WMI インスタンスオブジェクトへのハンドル。

[in] OutBufferSize

OutBuffer が指す出力バッファーのサイズ (バイト単位)。

[in] OutBuffer

出力バッファーへのポインター。

[out] BufferUsed

ドライバーが出力バッファーに配置するバイト数を受け取る場所へのポインター。 OutBufferSize パラメーターが指定する出力バッファーサイズが小さすぎる場合、ドライバーはこの場所を必要なバッファーサイズに設定します。

戻り値

OutBufferSize パラメーターの値がデータを受信するには出力バッファーが小さすぎることを示している場合、EvtWmiInstanceQueryInstance コールバック関数はSTATUS_BUFFER_TOO_SMALLを返す必要があります。それ以外の場合、コールバック関数はデータをバッファーにコピーし、STATUS_SUCCESSを返す必要があります。

注釈

EvtWmiInstanceQueryInstance コールバック関数を登録するには、WdfWmiInstanceCreate を呼び出す前に、ドライバーが関数のアドレスを WDF_WMI_INSTANCE_CONFIG 構造体に配置する必要があります。

フレームワークは、ドライバーが指定したインスタンスデータを WMI クライアントに送信する前に、必要なすべての WMI ヘッダー情報をデータに追加します。

ドライバーが WMI インスタンスオブジェクトのWDF_WMI_INSTANCE_CONFIG構造体の UseContextForQuery メンバーを読み取り専用データブロックの TRUE に設定した場合、ドライバーは EvtWmiInstanceQueryInstance コールバック関数を提供しません。

ドライバーが WMI クライアントに文字列データを提供する必要がある場合、ドライバーは WDF_WMI_BUFFER_APPEND_STRING 関数を呼び出して文字列を書式設定する必要があります。

EvtWmiInstanceQueryInstance コールバック関数の詳細については、「読み取り/書き込み WMI データブロックのサポート」および「Read-Only WMI データブロックのサポート」を参照してください。

フレームワークは、ドライバーの WMI イベントコールバック関数の呼び出しを相互に、またはドライバーの他のイベントコールバック関数と同期しません。 EvtWmiInstanceQueryInstance コールバック関数のデータが動的で、他のコールバック関数と共有されている場合、ドライバーはフレームワークの待機ロックまたはスピンロックを使用してデータへのアクセスを同期できます。

WMI の詳細については、「 Framework-Based ドライバーでの WMI のサポート」を参照してください。