Share via


MediaCollection.isDeleted method

[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 isDeleted method retrieves a value indicating whether the specified media item is in the deleted items folder.

Syntax

bRetVal = MediaCollection.isDeleted(
  item
)

Parameters

item [in]

Media object that might be deleted.

Return value

This method returns a Boolean.

Remarks

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

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

Examples

The following JScript example uses MediaCollection.isDeleted to test whether a particular media item, stored in the variable named mediaObject, is in the deleted items folder. If the media item has not been deleted already, it is moved to the deleted items folder. 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 media 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("Media 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

See also

Media Object

MediaCollection Object

MediaCollection.setDeleted

Settings.mediaAccessRights

Settings.requestMediaAccessRights