IWMPPlaylistCollection::importPlaylist 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 importPlaylist method adds a static playlist to the library.

Syntax

HRESULT importPlaylist(
  [in]  IWMPPlaylist *pItem,
  [out] IWMPPlaylist **ppImportedItem
);

Parameters

[in] pItem

Pointer to an IWMPPlaylist interface for the playlist that this method will add.

[out] ppImportedItem

Pointer to a pointer to an IWMPPlaylist interface for the added playlist.

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

Playlists that do not contain any media items cannot be added to the library by using this method. To create an empty playlist in the library, use the newPlaylist method. You can then fill the resulting playlist with media items by using IWMPPlaylist::appendItem or IWMPPlaylist::insertItem.

If you pass this method an auto playlist, the query is executed once and the result is added to the library as a static playlist. To add an auto playlist to the library and preserve its automatic behavior, use IWMPMediaCollection::add. For more information, see Static and Auto Playlists.

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