MediaCollection.setDeleted method

Article
06/20/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

MediaCollection.setDeleted(
  item,
  true
)

Parameters

item [in]: Media object being moved.
true [in]: Always specify this value.

Return value

This method does not return a value.

Remarks

This method does not remove files from the user's computer.

To use this method, full access to the library is required. For more information, see Library Access.

Windows Media Player 10 Mobile: This method is not supported.

Examples

The following JScript example uses MediaCollection.setDeleted to move a particular media item, stored in the variable named mediaObject, to the deleted items folder. The MediaCollection.isDeleted method first tests whether the item has already been deleted. The Player object was created with ID = "Player".

// Test whether the media item is in the deleted items folder.
if (!Player.mediaCollection.isDeleted(mediaObject)){

    // The item is available to be deleted; move it to 
    // the deleted items folder.
    Player.mediaCollection.setDeleted(mediaObject, true);

    // Inform the user that the operation succeeded.
    alert("Item moved to deleted items folder.");}

else
    // Tell the user the operation is unnecessary.
    alert("Item is already deleted!");
}

Requirements

Requirement	Value
Version	Windows Media Player version 7.0, Windows Media Player version 7.1, or Windows Media Player for Windows XP. This method is not supported for Windows Media Player 9 Series or later.
DLL	Wmp.dll