IWMPStringCollection::item method (wmp.h)

Article
4/26/2023

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The item method retrieves the string at the given index.

Syntax

HRESULT item(
  [in]  long lIndex,
  [out] BSTR *pbstrString
);

Parameters

[in] lIndex

long containing the index.

[out] pbstrString

Pointer to a BSTR containing the string.

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

The IWMPStringCollection interface is used to retrieve the set of values available for an attribute. For example, the IWMPMediaCollection::getAttributeStringCollection method can be used to retrieve a pointer to an IWMPStringCollection interface representing all the values for the Genre attribute within the Audio media type. The item method can then be used to iterate through all of the possible values for the Genre attribute.

To use this method, read access to the library is required. For more information, see Library Access.

Requirements

Requirement	Value
Minimum supported client	Windows Media Player 9 Series or later.
Target Platform	Windows
Header	wmp.h
DLL	Wmp.dll

Share via