IWMPMediaCollection::setDeleted 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 setDeleted method moves the specified media item to the deleted items folder.

Syntax

HRESULT setDeleted(
  [in] IWMPMedia    *pItem,
  [in] VARIANT_BOOL varfIsDeleted
);

Parameters

[in] pItem

Pointer to an IWMPMedia interface for the item to be moved.

[in] varfIsDeleted

Specifies whether the item should be moved. This value must always be true.

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 does not remove files from the user's computer.

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

Windows Media Player 10 Mobile: This method always returns E_INVALIDARG.

Requirements

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

Share via