ISDBApplication::PlaylistByID

From MediaMonkey Wiki
Revision as of 16:07, 19 January 2011 by Ludek (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

CoClass SDBApplication, Interface ISDBApplication

Property Get PlaylistByID(ID As Long) As ISDBPlaylist


Parameters

Name Type Description
ID Long ID of the playlist to get (use -1 to get root of all playlists)


Property description

Retrieves SDBPlaylist object of the given playlist ID.

When ID < 0, the root (virtual) playlist node is returned. Then you can use its ChildPlaylists property to get all the first-level playlists.

WARNING: Also if no playlist with the specified ID exists, the root (virtual) playlist will be returned. Be aware of this fact, especially if you are planning to remove a playlist. Making an error could remove the root, and so all playlists.

Example code

Dim Playlist : Set Playlist = SDB.PlaylistByTitle(-1)   ' Playlist represents the root (virtual) playlist
Dim List : Set List = Playlist.ChildPlaylists           ' List represents a list of all first-level playlists

Dim i, itm

For i = 0 To List.Count - 1                             ' For all (first-level) playlists in List...
  Set itm = List.Item(i)                                ' ... print out the number of child playlists and tracks
  fout.WriteLine itm.Title & " (" & CStr(itm.ChildPlaylists.Count) & "/" & CStr(itm.Tracks.Count) & ")"
Next

' in this case, fout represents a TextStream object (not shown here)