aboutsummaryrefslogtreecommitdiff
path: root/doc/man3/http_decode_url.3
blob: dd10f9c704e2de23edc998f51cfd03bc57dfabae (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
.TH HTTP_DECODE_URL 3 2024-08-22 0.4.0 "libweb Library Reference"

.SH NAME
http_decode_url \- decodes a percent-encoded null-terminated string

.SH SYNOPSIS
.LP
.nf
#include <libweb/http.h>
.P
int http_decode_url(const char *\fIurl\fP, bool \fIspaces\fP, char **\fIout\fP);
.fi

.SH DESCRIPTION
The
.IR http_encode_url ()
function decodes a null-terminated string given by
.I url
using percent-encoding as defined by RFC 3986.

.SH RETURN VALUE
On success, zero is returned, and
.I out
is assigned to a valid pointer to the decoded, null-terminated string.
On decoding error, a positive integer is returned. On fatal error, a
negative integer is returned.

.SH ERRORS
No errors are defined.

.SH SEE ALSO
.BR http_encode_url (3),
.BR libweb_http (7).

.SH COPYRIGHT
Copyright (C) 2023-2024 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.