IPortableDevicePropertiesBulk::QueueSetValuesByObjectList method (portabledeviceapi.h)

Article
02/22/2024

The QueueSetValuesByObjectList method queues a request to set one or more specified values on one or more specified objects on the device.

Syntax

HRESULT QueueSetValuesByObjectList(
  [in]  IPortableDeviceValuesCollection       *pObjectValues,
  [in]  IPortableDevicePropertiesBulkCallback *pCallback,
  [out] GUID                                  *pContext
);

Parameters

[in] pObjectValues

Pointer to an IPortableDeviceValuesCollection interface that contains the properties and values to set on specified objects. This interface holds one or more IPortableDeviceValues interfaces, each representing a single object. Each IPortableDeviceValues interface holds a collection of key/value pairs, where the key is the PROPERTYKEY identifying the property, and the value is a data type that varies by property. Each IPortableDeviceValues interface also holds one WPD_OBJECT_ID property that identifies the object to which this interface refers.

[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 to any client-implemented IPortableDevicePropertiesBulkCallback callbacks.

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 operation was queued successfully.

Remarks

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

Requirements

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