IWMPMediaCollection::getByAlbum 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 getByAlbum method retrieves a pointer to an IWMPPlaylist interface. This interface contains the media items from the specified album.

Syntax

HRESULT getByAlbum(
  [in]  BSTR         bstrAlbum,
  [out] IWMPPlaylist **ppMediaItems
);

Parameters

[in] bstrAlbum

String containing the album.

[out] ppMediaItems

Pointer to a pointer to an IWMPPlaylist interface for the retrieved media items.

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

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

There are two ways you ways you can retrieve an IWMPMediaCollection interface, and the behavior of the getByAlbum method depends on which of those two ways you use. If you retrieve the interface by calling IWMPCore::get_mediaCollection, then the getByAlbum method returns all the media items in the library that belong to the specified album. If you retrieve the interface by calling IWMPLibrary::get_mediaCollection, then the getByAlbum method returns only the audio items in the library that belong to the specified album.

Requirements

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

Share via