WdfDeviceQueryPropertyEx 関数 (wdfdevice.h)

  • [アーティクル]

[KMDF と UMDF に適用]

WdfDeviceQueryPropertyEx メソッドは、指定されたデバイス プロパティを取得します。

構文

NTSTATUS WdfDeviceQueryPropertyEx(
  [in]  WDFDEVICE                 Device,
  [in]  PWDF_DEVICE_PROPERTY_DATA DeviceProperty,
  [in]  ULONG                     BufferLength,
  [out] PVOID                     PropertyBuffer,
  [out] PULONG                    RequiredSize,
  [out] PDEVPROPTYPE              Type
);

パラメーター

[in] Device

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

[in] DeviceProperty

取得するデバイス プロパティを識別する WDF_DEVICE_PROPERTY_DATA 構造体へのポインター。

[in] BufferLength

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

[out] PropertyBuffer

要求された情報を受け取る呼び出し元によって割り当てられたバッファーへの呼び出し元から提供されるポインター。 BufferLength パラメーターが 0 の場合、ポインターは NULL にすることができます。

[out] RequiredSize

メソッドが PropertyBuffer に格納した情報のサイズをバイト単位で格納する、呼び出し元が指定した場所。 関数の戻り値が STATUS_BUFFER_TOO_SMALL場合、この場所は必要なバッファー サイズを受け取ります。

[out] Type

DEVPROPTYPE 変数へのポインター。 メソッドが成功した場合、このパラメーターには PropertyBuffer に格納されているプロパティ データのプロパティ型の値が含まれます。

戻り値

操作が成功した場合、 WdfDeviceQueryPropertyEx は STATUS_SUCCESSを返します。 その他の戻り値は次のとおりです。

リターン コード 説明
STATUS_BUFFER_TOO_SMALL
 指定されたバッファーが小さすぎて情報を受信できません。
STATUS_INVALID_PARAMETER
 指定された DeviceProperty 値が無効です。
 

メソッドは、他の NTSTATUS 値を返す場合があります。

ドライバーが無効なオブジェクト ハンドルを提供すると、バグ チェックが発生します。

注釈

WdfDeviceQueryPropertyEx を使用すると、統合プロパティ モデルを通じて公開されるすべてのプロパティを取得できます。一方、WdfDeviceQueryProperty メソッドでは、統合プロパティ モデルのサブセットに対してのみクエリを実行できます。

デバイス プロパティ データを受信する前に、ドライバーは通常、必要なバッファー サイズを取得するために WdfDeviceQueryPropertyEx メソッドを呼び出します。 一部のプロパティでは、データ サイズは、必要なサイズが返されたときと、ドライバーが WdfDeviceQueryPropertyEx を再度呼び出すときの間で変更される可能性があります。 したがって、ドライバーは、戻り値の状態がSTATUS_BUFFER_TOO_SMALLされるまで実行されるループ内で WdfDeviceQueryPropertyEx を呼び出す必要があります。

WdfDeviceQueryPropertyEx は、必要なバッファー サイズが不明で変更されていない場合にのみ使用することをお勧めします。その場合、ドライバーは WdfDeviceQueryPropertyEx を 1 回だけ呼び出す必要があるためです。 必要なバッファー サイズが不明または変化する場合、ドライバーは WdfDeviceAllocAndQueryPropertyEx を呼び出す必要があります。

関連するメソッドの詳細については、「 統合デバイス プロパティ モデルへのアクセス」を参照してください。

要件

要件 値
対象プラットフォーム ユニバーサル
最小 KMDF バージョン 1.13
最小 UMDF バージョン 2.0
Header wdfdevice.h (Wdf.h を含む)
Library Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF)
IRQL APC_LEVEL

こちらもご覧ください

WdfDeviceQueryInterfaceProperty

WdfDeviceQueryProperty