summaryrefslogtreecommitdiff
path: root/doc/man3/alpm_list.3
blob: 18c480143a8d65b47907a7888ead474fee2855a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
.TH "List Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*-
.ad l
.nh
.SH NAME
List Functions \- Functions to manipulate libalpm linked lists.  

.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "PMList * \fBalpm_list_first\fP (PMList *list)"
.br
.ti -1c
.RI "PMList * \fBalpm_list_next\fP (PMList *entry)"
.br
.ti -1c
.RI "void * \fBalpm_list_getdata\fP (PMList *entry)"
.br
.ti -1c
.RI "int \fBalpm_list_free\fP (PMList *entry)"
.br
.ti -1c
.RI "int \fBalpm_list_count\fP (PMList *list)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Functions to manipulate libalpm linked lists. 
.PP
.SH "Function Documentation"
.PP 
.SS "int alpm_list_count (PMList * list)"
.PP
Count the entries in a list. 
.PP
\fBParameters:\fP
.RS 4
\fIlist\fP the list to count 
.RE
.PP
\fBReturns:\fP
.RS 4
number of entries on success, NULL on error 
.RE
.PP

.SS "PMList* alpm_list_first (PMList * list)"
.PP
Get the first element of a list. 
.PP
\fBParameters:\fP
.RS 4
\fIlist\fP the list 
.RE
.PP
\fBReturns:\fP
.RS 4
the first element 
.RE
.PP

.SS "int alpm_list_free (PMList * entry)"
.PP
Free a list. 
.PP
\fBParameters:\fP
.RS 4
\fIentry\fP list to free 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on error 
.RE
.PP

.SS "void* alpm_list_getdata (PMList * entry)"
.PP
Get the data of a list entry. 
.PP
\fBParameters:\fP
.RS 4
\fIentry\fP the list entry 
.RE
.PP
\fBReturns:\fP
.RS 4
the data on success, NULL on error 
.RE
.PP

.SS "PMList* alpm_list_next (PMList * entry)"
.PP
Get the next element of a list. 
.PP
\fBParameters:\fP
.RS 4
\fIentry\fP the list entry 
.RE
.PP
\fBReturns:\fP
.RS 4
the next element on success, NULL on error 
.RE
.PP