aboutsummaryrefslogtreecommitdiffstats
path: root/libutf8_is_noncharacter.3
diff options
context:
space:
mode:
Diffstat (limited to 'libutf8_is_noncharacter.3')
-rw-r--r--libutf8_is_noncharacter.353
1 files changed, 53 insertions, 0 deletions
diff --git a/libutf8_is_noncharacter.3 b/libutf8_is_noncharacter.3
new file mode 100644
index 0000000..b9a657d
--- /dev/null
+++ b/libutf8_is_noncharacter.3
@@ -0,0 +1,53 @@
+.TH LIBUTF8_IS_NONCHARACTER 3 LIBUTF8
+.SH NAME
+libutf8_is_noncharacter - Test whether a codepoint is a Unicode non-character codepoint
+
+.SH SYNOPSIS
+.nf
+#include <libutf8.h>
+
+int \fBlibutf8_is_noncharacter\fP(uint_least32_t \fIcodepoint\fP);
+.fi
+.PP
+Link with
+.IR -lutf8 .
+
+.SH DESCRIPTION
+The
+.BR libutf8_is_noncharacter ()
+function tests whether a codepoint is a Unicode non-character
+codepoint, that is, codepoint that is reserved as invalid and
+has no special meaning.
+.PP
+The result is unspecified for codepoints above
+.BR LIBUTF8_ULTIMATE_CODEPOINT (3)
+which conform to the pattern of non-character codepoints.
+
+.SH RETURN VALUE
+The
+.BR libutf8_is_noncharacter ()
+function returns 1 if the predicate is true, and 0 otherwise.
+
+.SH ERRORS
+The
+.BR libutf8_is_noncharacter ()
+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_noncharacter ()
+T} MT-Safe AS-Safe AC-Safe
+.TE
+.sp
+
+.SH SEE ALSO
+.BR libutf8 (7),
+.BR libutf8_is_invalid (3)