IWMPMedia3::getItemInfoByType 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 getItemInfoByType method retrieves the value of the attribute corresponding to the specified attribute type and index.

Syntax

HRESULT getItemInfoByType(
  [in]  BSTR    bstrType,
  [in]  BSTR    bstrLanguage,
  [in]  long    lIndex,
  [out] VARIANT *pvarValue
);

Parameters

[in] bstrType

BSTR containing the type.

[in] bstrLanguage

BSTR containing the language. If the value is set to null or "" (empty string), the current locale string is used. Otherwise, the value must be a valid RFC 1766 language string such as "en-us".

[in] lIndex

long containing the index.

[out] pvarValue

Pointer to a VARIANT that contains the returned value.

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

This method retrieves the metadata for an individual digital media item or a media item that is part of a playlist.

This method supports attributes with multiple values and attributes with complex values. The getItemInfo method does not support attributes with multiple values and attributes with complex values.

The attributeCount method retrieves the number of attribute names available for a given media item. Index numbers can then be used with the getAttributeName method to determine the name of each available attribute. Individual attribute names can be passed to the name parameter of getItemInfoByType.

The getAttributeCountByType method returns the number of attributes that correspond to a particular attribute name for a given media item. Index numbers can then be passed to the index parameter of getItemInfoByType. This is useful when a media item has been categorized under multiple genres, for example.

The set of attributes available from sources other than the local library (remote libraries, portable devices, or CDs is defined by the other sources.

Before calling this method, you must have read access to the library. For more information, see Library Access.

Windows Media Player 10 Mobile: This method always returns E_INVALIDARG.

Requirements

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

Share via