Windows Media Player 11 SDK IWMPMediaCollection2::getStringCollectionByQuery
Previous | Next |
IWMPMediaCollection2::getStringCollectionByQuery
The getStringCollectionByQuery method retrieves a pointer to an IWMPStringCollection interface. This interface represents a set of all string values for a specified attribute that match the query conditions.
Syntax
Parameters
bstrAttribute
[in] String containing the attribute name.
pQuery
[in] Pointer to the IWMPQuery interface that represents the query that defines the conditions used to retrieve the string collection.
bstrMediaType
[in] String containing the media type. Must contain one of the following values: "audio", "video", "photo", "playlist", or "other".
bstrSortAttribute
[in] String containing the attribute name used for sorting. An empty string means no sorting is applied.
fSortAscending
[in] VARIANT_BOOL that indicates whether the playlist must be sorted in ascending order.
ppStringCollection
[out] Address of a variable that receives a pointer to an IWMPStringCollection interface for the retrieved set of string values.
Return Values
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
Compound queries using IWMPQuery are not case sensitive.
When the compound query specified by the pQuery parameter contains a condition built on the MediaType attribute, that condition is ignored. The value for the bstrMediaType parameter is always used. For example, if the compound query contains the condition "MediaType Equals audio" and the value for the bstrMediaType parameter is "video", the resulting playlist will contain only video items.
Windows Media Player 10 Mobile: This method is not supported.
Requirements
Version: Windows Media Player 11.
Header: Include wmp.h.
Library: Use wmp.dll.
See Also
- IWMPMediaCollection2 Interface
- IWMPQuery Interface
- IWMPStringCollection Interface
- MediaType Attribute
Previous | Next |