IMDSPDevice3::GetFormatCapability
The GetFormatCapability method retrieves information from a device about the values or ranges of values supported by the device for each aspect of a particular object format.
Syntax
HRESULT GetFormatCapability(WMDM_FORMATCODEformat,WMDM_FORMAT_CAPABILITY*pFormatSupport);
Parameters
format
[in] WMDM_FORMATCODE
Enumerated value representing inquired format.
pFormatSupport
[out] Returned WMDM_FORMAT_CAPABILITY structure containing the values or ranges of values supported for each aspect of a particular object format.
Return Values
The method returns an HRESULT. All the interface methods in Windows Media Device Manager can return any of the following classes of error codes:
- Standard COM error codes
- Windows error codes converted to HRESULT values
- Windows Media Device Manager error codes
For an extenstive list of possible error codes, see Error Codes.
Possible values include, but are not limited to, those in the following table.
Return code | Description |
S_OK | The method succeeded. |
E_INVALIDARG | A parameter is an invalid or NULL pointer. |
WMDM_E_NOTSUPPORTED | The device does not support this method or the format specified. |
Remarks
This method can be called for any of the supported formats. The list of supported formats are represented by g_wszWMDMFormatsSupported device property.
For a particular format, this method should return all configurations of supported properties (for example, combinations of bit rate and sample rate). This information is expressed as a format capability. For detailed information, see WMDM_FORMAT_CAPABILITY.
Requirements
Header: Defined in mswmdm.h.
Library: mssachlp.lib
See Also