IWMPMediaCollection::getMediaAtom 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 getMediaAtom method retrieves the index at which a given attribute resides within the set of available attributes.

Syntax

HRESULT getMediaAtom(
  [in]  BSTR bstrItemName,
  [out] long *plAtom
);

Parameters

[in] bstrItemName

String containing the name of the item for which the index should be retrieved.

[out] plAtom

Pointer to a long containing the index.

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 index number retrieved with this method can be passed to the IWMPMedia::getItemInfoByAtom to access attribute values. This technique is generally more efficient when working with large playlists than accessing an attribute value by name through IWMPMedia::getItemInfo.

Before calling this method, you must have read access to the library. 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