IWMPMedia::getItemInfoByAtom 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 getItemInfoByAtom method retrieves the value of the attribute with the specified index number.

Syntax

HRESULT getItemInfoByAtom(
  [in]  long lAtom,
  [out] BSTR *pbstrVal
);

Parameters

[in] lAtom

long specifying the index at which a given attribute resides within the set of available attributes.

[out] pbstrVal

Pointer to a BSTR containing 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 can be used to retrieve metadata for a specific media item by using an attribute index number. The get_attributeCount method can be used to determine the number of attributes available for the media item.

The getMediaAtom method of the MediaCollection object can also be used to retrieve the index of a particular attribute. This technique is generally more efficient than the getItemInfo or getItemInfoByType methods when working with large playlists.

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

Windows Media Player 10 Mobile: Attributes for a media item are available only during playback unless they are retrieved from the item through the media collection.

Requirements

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

Share via