From de7f4b2ffcd92dfeada9235ce857b801a4851da7 Mon Sep 17 00:00:00 2001 From: Xavier Del Campo Romero Date: Thu, 9 Oct 2025 11:18:03 +0200 Subject: Add man3 pages for the form API --- doc/man3/form_value.3 | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 doc/man3/form_value.3 (limited to 'doc/man3/form_value.3') diff --git a/doc/man3/form_value.3 b/doc/man3/form_value.3 new file mode 100644 index 0000000..1eaf46b --- /dev/null +++ b/doc/man3/form_value.3 @@ -0,0 +1,47 @@ +.TH FORM_VALUE 3 2025-10-09 0.5.0 "libweb Library Reference" + +.SH NAME +form_value \- parse application/x-www-form-urlencoded data + +.SH SYNOPSIS +.LP +.nf +#include +.P +const char *form_value(const struct form *\fIf\fP, const char *\fIkey\fP); +.fi + +.SH DESCRIPTION +The +.IR form_value (3) +function takes a +.I struct form +instance previously allocated by +.IR form_alloc (3), +pointed to by +.IR f , +and returns the value for a given +.IR key . + +.SH RETURN VALUE +On success, a valid pointer with the pair value is returned. +Otherwise, a null pointer is returned. + +.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_foreach (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. -- cgit v1.2.3