blob: 1c28600471160cca6335bed448a9f626830396a9 (
plain) (
blame)
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
|
.TH FORM_FOREACH 3 2025-10-09 0.5.0 "libweb Library Reference"
.SH NAME
form_foreach \- parse application/x-www-form-urlencoded data
.SH SYNOPSIS
.LP
.nf
#include <libweb/form.h>
.P
typedef int (*\fIform_iter\fP)(const char *\fIkey\fP, const char *\fIvalue\fP, void *\fIuser\fP);
int form_foreach(const struct form *\fIf\fP, form_iter \fIit\fP, void *\fIuser\fP);
.fi
.SH DESCRIPTION
The
.IR form_foreach (3)
function takes a
.I struct form
instance previously allocated by
.IR form_alloc (3),
pointed to by
.IR f ,
and iterates over the object, calling the user-defined function pointed to by
.I it
for every key-value pair.
.SH RETURN VALUE
On success, zero is returned.
Any non-zero return value coming from
.I it
makes
.IR form_foreach (3)
to stop its execution and propagate the return value to the caller.
.SH EXAMPLE
See
.IR libweb_form (7)
for a complete example on how to use this library.
.SH SEE ALSO
.BR form_alloc (3),
.BR form_value (3),
.BR form_free (3),
.BR libweb_form (7).
.SH COPYRIGHT
Copyright (C) 2023-2025 libweb contributors
.P
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
|