summaryrefslogtreecommitdiff
path: root/docs/u8c_u8enc.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/u8c_u8enc.3')
-rw-r--r--docs/u8c_u8enc.327
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/u8c_u8enc.3 b/docs/u8c_u8enc.3
new file mode 100644
index 0000000..64feaf1
--- /dev/null
+++ b/docs/u8c_u8enc.3
@@ -0,0 +1,27 @@
+.\" Automatically generated by Pandoc 2.14.0.2
+.\"
+.TH "" "" "" "" ""
+.hy
+.SH NAME
+.PP
+u8c_u8enc - UTF-8 encode - Convert an UTF-32 string to UTF-8.
+.SH DECLARATION
+.IP
+.nf
+\f[C]
+# include <stdbool.h>
+# include <stddef.h>
+# include <uchar.h>
+extern bool u8c_u8enc(size_t * const sz,unsigned char const * * const out,char32_t const * const in);
+\f[R]
+.fi
+.SH DESCRIPTION
+.PP
+The function \f[C]u8c_u8enc\f[R] converts the given UTF-32 string
+(\f[B]in\f[R]) to UTF-8 (\f[B]out\f[R]).
+.PP
+The size of the output string (excluding the null-terminator) is placed
+into \f[B]sz\f[R], if [\f[B]sz\f[R]] is not equal to \f[I]NULL\f[R].
+.SH VERSION
+.PP
+u8c 0