~ubuntu-branches/debian/wheezy/libnjb/wheezy

« back to all changes in this revision

Viewing changes to man/man3/NJB_Get_Playlist.3

  • Committer: Bazaar Package Importer
  • Author(s): Shaun Jackman
  • Date: 2004-05-25 13:06:10 UTC
  • Revision ID: james.westby@ubuntu.com-20040525130610-vexcucw1qxq1g4dp
Tags: upstream-1.1
ImportĀ upstreamĀ versionĀ 1.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH NJB_GET_PLAYLIST 3 "March 2001"
 
2
.SH NAME
 
3
NJB_Get_Playlist, NJB_Reset_Get_Playlist \- Get playlist definitions from 
 
4
the NJB
 
5
.SH LIBRARY
 
6
libnjb
 
7
.SH SYNOPSIS
 
8
#include <libnjb.h>
 
9
 
 
10
extern int njb_error
 
11
 
 
12
void NJB_Reset_Get_Playlist(njb_t
 
13
.BR *njb )
 
14
 
 
15
playlist_t *NJB_Get_Playlist(njb_t
 
16
.BR *njb )
 
17
 
 
18
.SH DESCRIPTION
 
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.
 
24
 
 
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)
 
29
function.
 
30
 
 
31
When all playlists have been fetched, NJB_Get_Playlist returns a NULL
 
32
pointer, and sets 
 
33
.B njb_error
 
34
to EO_NOMEM.
 
35
 
 
36
.SH RETURN VALUES
 
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
 
39
.B njb_error
 
40
is set as follows:
 
41
.LP
 
42
.TP 10
 
43
EO_BADDATA
 
44
An invalid playlist was returned.
 
45
.TP 10
 
46
EO_BADSTATUS
 
47
A non-zero status was encountered when attempting to get a tag.
 
48
.TP 10
 
49
EO_EOM
 
50
No more playlists remain on the NJB.
 
51
.TP 10
 
52
EO_NOMEM
 
53
There was not enough memory available to create the playlist_t object.
 
54
.TP 10
 
55
EO_RDSHORT
 
56
The NJB returned fewer bytes than expected on the bulk data pipe.
 
57
.TP 10
 
58
EO_USBBLK
 
59
An I/O error occurred on the bulk data pipe.
 
60
.TP 10
 
61
EO_USBCTL
 
62
An I/O error occurred on the control pipe.
 
63
.SH SEE ALSO
 
64
playlist_destroy(3)