Share via

IPortableDevicePropertiesBulk::QueueGetValuesByObjectFormat メソッド (portabledeviceapi.h)

  • [アーティクル]

QueueGetValuesByObjectFormat インターフェイスは、デバイス上の特定の形式のオブジェクトのプロパティの要求をキューに入れます。

構文

HRESULT QueueGetValuesByObjectFormat(
  [in]  REFGUID                               pguidObjectFormat,
  [in]  LPCWSTR                               pszParentObjectID,
  [in]  const DWORD                           dwDepth,
  [in]  IPortableDeviceKeyCollection          *pKeys,
  [in]  IPortableDevicePropertiesBulkCallback *pCallback,
  [out] GUID                                  *pContext
);

パラメーター

[in] pguidObjectFormat

オブジェクト形式を指定する GUID へのポインター。 この型のオブジェクトのみがクエリされます。

[in] pszParentObjectID

検索を開始する親オブジェクトのオブジェクト ID を含む null で終わる文字列へのポインター。 デバイス上のすべてのオブジェクトを検索するには、 WPD_DEVICE_OBJECT_IDを指定します。

[in] dwDepth

親の下で検索する最大深さ (1 は直下の子のみを意味します)。 この数は、レベルの実際の数よりも大きいことが許容されます。 任意の深さを検索するには、0xFFFFFFFFを指定します

[in] pKeys

取得するプロパティを含む IPortableDeviceKeyCollection インターフェイスへのポインター。 Windows ポータブル デバイスで定義されているプロパティの一覧については、「 プロパティと属性」を参照してください。 指定した形式のすべてのプロパティを示すには 、NULL を 指定します。

[in] pCallback

取得時に情報を受け取るアプリケーション実装 の IPortableDevicePropertiesBulkCallback インターフェイスへのポインター。

[out] pContext

実装されている場合、 IPortableDevicePropertiesBulkCallback コールバックで要求を開始、取り消し、または識別するために使用される GUID へのポインター。

戻り値

このメソッドは HRESULT を返します。 有効な値を次の表に示しますが、これ以外にもあります。

リターン コード 説明
S_OK
 操作が正常にキューに入れられます。

注釈

pguidObjectFormat パラメーターにWPD_OBJECT_FORMAT_ALLを指定すると、このメソッドはデバイス上のすべてのオブジェクトのプロパティを返します。

pszParentObjectID パラメーターが空の文字列 ("") に設定されている場合、メソッドは、次の表で説明するように dwDepth パラメーターに依存する検索を実行します。

dwDepth メソッドは を返します
0 結果なし
1 指定したデバイスのみの値。
2 指定したデバイスと、そのデバイスで見つかったすべての機能オブジェクトの値。
 

pszParentObjectID パラメーターが WPD_DEVICE_OBJECT_ID に設定されている場合、メソッドは次の表で説明するように dwDepth パラメーターに依存する検索を実行します。

dwDepth メソッドは を返します
0 指定したデバイスのみの値。
1 指定したデバイスと、そのデバイスで見つかったすべての機能オブジェクトの値。
 

キューに入った要求は、アプリケーションが Start を呼び出すまで開始されません。 このメソッドの使用方法の詳細については、「 IPortableDevicePropertiesBulk インターフェイス」を参照してください。

パフォーマンスの問題により、 pKeys パラメーターが NULL の場合、一部のデバイスはプロパティの包括的な一覧を返さない場合があります。

要件

要件 値
対象プラットフォーム Windows
ヘッダー portabledeviceapi.h
Library PortableDeviceGUIDs.lib

こちらもご覧ください

IPortableDevicePropertiesBulk インターフェイス