aboutsummaryrefslogtreecommitdiffstats
path: root/libutf8_is_invalid.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--libutf8_is_invalid.351
1 files changed, 51 insertions, 0 deletions
diff --git a/libutf8_is_invalid.3 b/libutf8_is_invalid.3
new file mode 100644
index 0000000..9641c5f
--- /dev/null
+++ b/libutf8_is_invalid.3
@@ -0,0 +1,51 @@
+.TH LIBUTF8_IS_INVALID 3 LIBUTF8
+.SH NAME
+libutf8_is_invalid - Test whether a codepoint is invalid Unicode
+
+.SH SYNOPSIS
+.nf
+#include <libutf8.h>
+
+int \fBlibutf8_is_invalid\fP(uint_least32_t \fIcodepoint\fP);
+.fi
+.PP
+Link with
+.IR -lutf8 .
+
+.SH DESCRIPTION
+The
+.BR libutf8_is_invalid ()
+function tests whether a codepoint is invalid Unicode.
+
+.SH RETURN VALUE
+The
+.BR libutf8_is_invalid ()
+function returns 1 if the predicate is true, and 0 otherwise.
+
+.SH ERRORS
+The
+.BR libutf8_is_invalid ()
+function cannot fail.
+
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.PP
+.TS
+allbox;
+lb lb lb lb
+l l l l.
+Interface Thread safety Async-signal safety Async-cancel safety
+T{
+.BR libutf8_is_invalid ()
+T} MT-Safe AS-Safe AC-Safe
+.TE
+.sp
+
+.SH SEE ALSO
+.BR libutf8 (7)
+.BR libutf8_is_valid (3),
+.BR libutf8_is_noncharacter (3),
+.BR libutf8_is_surrogate (3),
+.BR LIBUTF8_ULTIMATE_CODEPOINT (3),
+.BR libutf8_is_continuation (3)