IWMPMediaCollection::remove 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 remove method removes a specified item from the media collection.

Syntax

HRESULT remove(
  [in] IWMPMedia    *pItem,
  [in] VARIANT_BOOL varfDeleteFile
);

Parameters

[in] pItem

Pointer to an IWMPMedia interface that identifies the item to remove.

[in] varfDeleteFile

Specifies whether the method should remove the specified item.

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 deletes an item from the library. This method does not delete files from the user's computer.

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