doc/man3/html_encode.3


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

.TH HTML_ENCODE 3 2025-09-28 0.4.0 "libweb Library Reference"

.SH NAME
html_encode \- Encodes a string as HTML

.SH SYNOPSIS
.LP
.nf
#include <libweb/html.h>
.P
char *html_encode(const char *\fIs\fP);
.fi

.SH DESCRIPTION
The
.IR html_encode ()
function encodes the null-terminated string given by
.IR s ,
replacing HTML reserved symbols, such as
.I <
or
.IR > ,
into their equivalents, such as
.I &gt;
or
.IR &lt; .

.SH RETURN VALUE
On success, a valid pointer to a HTML-encoded, null-terminated
string is returned. On failure, a null pointer is returned.

.SH ERRORS
No errors are defined.

.SH SEE ALSO
.BR html_node_set_value (3),
.BR libweb_html (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.