1
.TH NJB_GET_PLAYLIST 3 "March 2001"
3
NJB_Get_Playlist, NJB_Reset_Get_Playlist \- Get playlist definitions from
12
void NJB_Reset_Get_Playlist(njb_t
15
playlist_t *NJB_Get_Playlist(njb_t
19
This function is used to fetch a playlist definition from the NJB. The
20
playlists are returned in no particular order, with each
21
NJB_Get_Playlist query returning a single playlist. The calling
22
program should invoke NJB_Reset_Get_Playlist before making calls to
23
NJB_Get_Playlist, to ensure that all playlists are returned.
25
Each call to NJB_Get_Playlist returns a playlist_t object, which lists all
26
the songs in the playlist. It is the program's responsibility to free
27
this memory when the playlist is no longer needed, using the
28
.BR playlist_destroy (3)
31
When all playlists have been fetched, NJB_Get_Playlist returns a NULL
37
A playlist_t object is returned from a successful query. If no more
38
playlists remain, or an error is encountered, a NULL pointer is returned and
44
An invalid playlist was returned.
47
A non-zero status was encountered when attempting to get a tag.
50
No more playlists remain on the NJB.
53
There was not enough memory available to create the playlist_t object.
56
The NJB returned fewer bytes than expected on the bulk data pipe.
59
An I/O error occurred on the bulk data pipe.
62
An I/O error occurred on the control pipe.