IContentDirectory::GetSortCapabilities
A version of this page is also available for
4/8/2010
This method returns the sorting capabilities supported by this ContentDirectory instance.
Syntax
virtual DWORD GetSortCapabilities(
wstring* pstrSortCaps
) = 0;
Parameters
- pstrSortCaps
[in, out] Pointer to a string that, upon return, contains the sorting capabilities supported by this ContentDirectory instance. Corresponds to the SortCapabilities state variable.
Return Value
Custom implementations can return appropriate error codes. Should return SUCCESS_AV if the method succeeds. Otherwise, should return an error code defined in WinError.h or UPnP.h, or one of the UPnP AV-specific return values specified in UPnPAVError, especially the following error documented for this action in the ContentDirectory DCP documentation:
- ERROR_AV_UPNP_ACTION_FAILED
The implementation of this method in IContentDirectoryImpl returns the errors in the following table.
| Value | Description |
|---|---|
ERROR_AV_POINTER |
The pstrSortCaps pointer is NULL. |
SUCCESS_AV |
An empty string was set to indicate that the default implementation does not support sorting. |
Remarks
This method corresponds to the ContentDirectory service's GetSortCapabilities action.
The implementation of this method in IContentDirectoryImpl sets an empty string in the pstrSortCaps parameter to indicate that no sorting is supported. Your implementation of this method should return the appropriate sort capabilities for your IContentDirectory-derived class.
For more information about the actions and sorting mechanisms defined by the ContentDirectory service, see UPnP AV DCP Documentation.
Requirements
| Header | av_upnp.h |
| Library | Av_upnp.lib |
| Windows Embedded CE | Windows CE 5.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |