Метод 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
Указатель на строку, завершающуюся нулевым значением, которая содержит идентификатор объекта родительского объекта, с которого должен начаться поиск. Чтобы выполнить поиск по всем объектам на устройстве, укажите WPD_DEVICE_OBJECT_ID.
[in] dwDepth
Максимальная глубина поиска под родительским элементом, где 1 означает только непосредственные дочерние элементы. Допустимо, чтобы это число превышало фактическое число уровней. Чтобы выполнить поиск по любой глубине, укажите 0xFFFFFFFF
[in] pKeys
Указатель на интерфейс IPortableDeviceKeyCollection , содержащий извлекаемые свойства. Список свойств, определенных переносными устройствами Windows, см. в разделе Свойства и атрибуты. Укажите ЗНАЧЕНИЕ NULL , чтобы указать все свойства из указанного формата.
[in] pCallback
Указатель на интерфейс IPortableDevicePropertiesBulkCallback , который будет получать сведения по мере их получения.
[out] pContext
Указатель на GUID, который будет использоваться для запуска, отмены или идентификации запроса в обратных вызовах IPortableDevicePropertiesBulkCallback , если они реализованы.
Возвращаемое значение
Метод возвращает HRESULT. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице.
| Код возврата | Описание |
|---|---|
|
Операция успешно поставлена в очередь. |
Комментарии
Если указать WPD_OBJECT_FORMAT_ALL для параметра pguidObjectFormat , этот метод вернет свойства для всех объектов на устройстве.
Если для параметра pszParentObjectID задана пустая строка (""), метод выполнит поиск, зависящий от параметра dwDepth , как описано в следующей таблице.
| dwDepth | Метод завершается |
| 0 | Нет результатов |
| 1 | Значения только для указанного устройства. |
| 2 | Значения для указанного устройства и всех функциональных объектов, найденных на этом устройстве. |
Если параметру pszParentObjectID присвоено значение WPD_DEVICE_OBJECT_ID, метод выполнит поиск, зависящий от параметра dwDepth , как описано в следующей таблице.
| dwDepth | Метод завершается |
| 0 | Значения только для указанного устройства. |
| 1 | Значения для указанного устройства и всех функциональных объектов, найденных на этом устройстве. |
Запрос в очереди не запускается, пока приложение не вызовет start. Дополнительные сведения об использовании этого метода см. в разделе Интерфейс IPortableDevicePropertiesBulk.
Из-за проблем с производительностью некоторые устройства могут не возвращать полный список свойств, если параметр pKeys имеет значение NULL.
Требования
| Требование | Значение |
|---|---|
| Целевая платформа | Windows |
| Header | portabledeviceapi.h |
| Библиотека | PortableDeviceGUIDs.lib |