WPD_COMMAND_COMMON_GET_OBJECT_IDS_FROM_PERSISTENT_UNIQUE_IDS command

Retrieves the current object IDs of one or more objects, given their previously acquired Persistent Unique IDs (PUIDs).

Command category

WPD_CATEGORY_COMMON

Parameters

ParametersVarTypeDescription

The driver expects the following parameters.

WPD_PROPERTY_COMMON_PERSISTENT_UNIQUE_IDS

VT_UNKNOWN

Required. An IPortableDevicePropVariantCollection of one or more VT_LPWSTR items, each of which represents a PUID of a device.

Return value

ResultVarTypeDescription

The driver should return the following results.

WPD_PROPERTY_COMMON_OBJECT_IDS

VT_UNKNOWN

Required. An IPortableDevicePropVariantCollection of VT_LPWSTR items, each of which specifies an object ID. This collection is in the same order as the submitted PUIDs. If an object ID is not found, its value is the empty string (L""). The two lists will have the same number of items.

WPD_PROPERTY_COMMON_HRESULT

VT_ERROR

Required. An HRESULT that indicates success or failure to carry out the command. If the caller is making an invalid request, the driver should return HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED) and is not required to return any other result values. Error codes include Windows Portable Devices error codes or any other appropriate error codes.

WPD_PROPERTY_COMMON_DRIVER_ERROR_CODE

VT_UI4

Optional. A driver-specific error code. This value is typically used by device vendors to improve diagnosis of device errors while using their applications. General purpose applications would ignore it and rely solely on WPD_PROPERTY_COMMON_HRESULT instead.

Calling methods

IPortableDeviceContent::GetObjectIDsFromPersistentUniqueIDs

Requirements

Header

PortableDevice.h

See also

Commands

 

 

Send comments about this topic to Microsoft

Show: