IPortableDevicePropertiesBulk::QueueGetValuesByObjectList method (portabledeviceapi.h)

Article
02/22/2024

The QueueGetValuesByObjectList method queues a request for one or more specified properties from one or more specified objects on the device.

Syntax

HRESULT QueueGetValuesByObjectList(
  [in]  IPortableDevicePropVariantCollection  *pObjectIDs,
  [in]  IPortableDeviceKeyCollection          *pKeys,
  [in]  IPortableDevicePropertiesBulkCallback *pCallback,
  [out] GUID                                  *pContext
);

Parameters

[in] pObjectIDs

Pointer to an IPortableDevicePropVariantCollection interface that lists the object IDs of all the objects to query. These will be of type VT_LPWSTR.

[in] pKeys

Pointer to an IPortableDeviceKeyCollection interface that specifies the properties to request. For a list of properties defined by Windows Portable Devices, see Properties and Attributes. Specify NULL to indicate all properties from the specified objects.

[in] pCallback

Pointer to an application-implemented IPortableDevicePropertiesBulkCallback interface that will receive the information as it is retrieved.

[out] pContext

Pointer to a GUID that is used to start, cancel, or identify the request IPortableDevicePropertiesBulkCallback callbacks, if implemented.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.

Remarks

The queued request is not started until the application calls Start. For more information on how to use this method, see IPortableDevicePropertiesBulk Interface.

Due to performance issues, some devices may not return a comprehensive list of properties when the pKeys parameter is NULL.

Requirements

Requirement	Value
Target Platform	Windows
Header	portabledeviceapi.h
Library	PortableDeviceGUIDs.lib