IPortableDevicePropertiesBulkCallback::OnProgress method (portabledeviceapi.h)

Article
10/13/2021

The OnProgress method is called by the SDK when a bulk operation started by IPortableDevicePropertiesBulk::Start has sent data to the device and received some information back.

Syntax

HRESULT OnProgress(
  [in] REFGUID                         pContext,
  [in] IPortableDeviceValuesCollection *pResults
);

Parameters

[in] pContext

Pointer to a GUID that identifies which operation is in progress. This value is produced by a Queue... method of the IPortableDevicePropertiesBulk interface.

[in] pResults

Pointer to an IPortableDeviceValuesCollection interface that contains the results retrieved from the device. This interface will hold one or more IPortableDeviceValues interfaces. Each of these interfaces will hold one WPD_OBJECT_ID property with a string value (VT_LPSTR) specifying the object ID of the object that these values pertain to. The rest of the values in each IPortableDeviceValues interface vary, depending on the bulk operation being reported. For the QueueGetValuesByObjectFormat and QueueGetValuesByObjectList methods, they will be retrieved values of varying types. For QueueSetValuesByObjectList, they will be VT_ERRORHRESULT values for any errors encountered when setting values.

Return value

The application should return either S_OK, or an error code to abandon the operation. All error codes are handled the same way.

Remarks

This method can be called once or multiple times, depending on how large the operation is.

This method does not necessarily retrieve all properties at once, nor does it return the properties in a particular order.

If this method is called multiple times, it may return properties for the same object identifier each time.

Requirements

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

Share via