IPortableDeviceCapabilities::GetSupportedFormatProperties method (portabledeviceapi.h)

Article
10/13/2021

The GetSupportedFormatProperties method retrieves the properties supported by objects of a specified format on the device.

Syntax

HRESULT GetSupportedFormatProperties(
  [in]  REFGUID                      Format,
  [out] IPortableDeviceKeyCollection **ppKeys
);

Parameters

[in] Format

A REFGUID that specifies the format of the object. For a list of formats that are defined by Windows Portable Devices, see Object Formats.

[out] ppKeys

Address of a variable that receives a pointer to an IPortableDeviceKeyCollection interface that contains the supported properties for the specified format. For a list of properties defined by Windows Portable Devices, see Properties and Attributes. The caller must release this interface when it is done with it.

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

You can specify WPD_OBJECT_FORMAT_ALL for the Format parameter to retrieve the complete set of property attributes.

If an object does not have a value assigned to a specific property, or if the property was deleted, a device might not report the property at all when enumerating its properties. Another device might report the property, but with an empty string or a value of zero. In order to avoid this inconsistency, you can call this method to learn all the properties you can set on a specific object.

Requirements

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