ISDBApplication::PlaylistByTitle: Difference between revisions
Jump to navigation
Jump to search
m (Edited description and code example) |
(better style, unificatiion with PlaylistByID page) |
||
| Line 4: | Line 4: | ||
{{MethodParameters | {{MethodParameters | ||
|Title |String |Name of the playlist to get (use | |Title |String |Name of the playlist to get (use empty string to get root of all playlists)}} | ||
===Property description=== | ===Property description=== | ||
Retrieves [[SDBPlaylist]] object of the given playlist name. If multiple playlists with the same name exist, ''PlaylistByTitle'' | Retrieves [[SDBPlaylist]] object of the given playlist name. If multiple playlists with the same name exist, ''PlaylistByTitle'' returns the first one it finds in the database. | ||
Call method with empty string as the argument to get the (virtual) root playlist node. Then you can use its [[ISDBPlaylist::ChildPlaylists|ChildPlaylists]] property to get all the first-level playlists. | |||
'''WARNING:''' Also if no playlist with the specified ''Title'' exists, the | '''WARNING:''' Also if no playlist with the specified ''Title'' exists, the (virtual) root 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=== | ===Example code=== | ||
| Line 26: | Line 26: | ||
' in this case, fout represents a TextStream object (not shown here)</source> | ' in this case, fout represents a TextStream object (not shown here)</source> | ||
===Related Topics=== | |||
* [[ISDBApplication::PlaylistByID]] | |||
[[Category:Scripting|{{PAGENAME}}]] | [[Category:Scripting|{{PAGENAME}}]] | ||
Revision as of 20:01, 20 April 2013
CoClass SDBApplication, Interface ISDBApplication
Property Get PlaylistByTitle(Title As String) As ISDBPlaylist
Parameters
| Name | Type | Description |
|---|---|---|
| Title | String | Name of the playlist to get (use empty string to get root of all playlists) |
Property description
Retrieves SDBPlaylist object of the given playlist name. If multiple playlists with the same name exist, PlaylistByTitle returns the first one it finds in the database.
Call method with empty string as the argument to get the (virtual) root playlist node. Then you can use its ChildPlaylists property to get all the first-level playlists.
WARNING: Also if no playlist with the specified Title exists, the (virtual) root 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("") ' 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)