summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/mblen.3p
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3p/mblen.3p
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3p/mblen.3p')
-rw-r--r--upstream/archlinux/man3p/mblen.3p139
1 files changed, 139 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/mblen.3p b/upstream/archlinux/man3p/mblen.3p
new file mode 100644
index 00000000..9b8e32eb
--- /dev/null
+++ b/upstream/archlinux/man3p/mblen.3p
@@ -0,0 +1,139 @@
+'\" et
+.TH MBLEN "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\"
+.SH PROLOG
+This manual page is part of the POSIX Programmer's Manual.
+The Linux implementation of this interface may differ (consult
+the corresponding Linux manual page for details of Linux behavior),
+or the interface may not be implemented on Linux.
+.\"
+.SH NAME
+mblen
+\(em get number of bytes in a character
+.SH SYNOPSIS
+.LP
+.nf
+#include <stdlib.h>
+.P
+int mblen(const char *\fIs\fP, size_t \fIn\fP);
+.fi
+.SH DESCRIPTION
+The functionality described on this reference page is aligned with the
+ISO\ C standard. Any conflict between the requirements described here and the
+ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
+.P
+If
+.IR s
+is not a null pointer,
+\fImblen\fR()
+shall determine the number of bytes constituting the character
+pointed to by
+.IR s .
+Except that the shift state of
+\fImbtowc\fR()
+is not affected, it shall be equivalent to:
+.sp
+.RS 4
+.nf
+
+mbtowc((wchar_t *)0, \fIs\fP, \fIn\fP);
+.fi
+.P
+.RE
+.P
+The implementation shall behave as if no function defined in this volume of POSIX.1\(hy2017
+calls
+\fImblen\fR().
+.P
+The behavior of this function is affected by the
+.IR LC_CTYPE
+category of the current locale. For a state-dependent encoding, this
+function shall be placed into its initial state by a call for which its
+character pointer argument,
+.IR s ,
+is a null pointer. Subsequent calls with
+.IR s
+as other than a null pointer shall cause the internal state of the
+function to be altered as necessary. A call with
+.IR s
+as a null pointer shall cause this function to return a non-zero value
+if encodings have state dependency, and 0 otherwise. If the
+implementation employs special bytes to change the shift state, these
+bytes shall not produce separate wide-character codes, but shall be
+grouped with an adjacent character. Changing the
+.IR LC_CTYPE
+category causes the shift state of this function to be unspecified.
+.P
+The
+\fImblen\fR()
+function need not be thread-safe.
+.SH "RETURN VALUE"
+If
+.IR s
+is a null pointer,
+\fImblen\fR()
+shall return a non-zero or 0 value, if character encodings,
+respectively, do or do not have state-dependent encodings. If
+.IR s
+is not a null pointer,
+\fImblen\fR()
+shall either return 0 (if
+.IR s
+points to the null byte), or return the number of bytes that
+constitute the character (if the next
+.IR n
+or fewer bytes form a valid character), or return \-1 (if they do
+not form a valid character)
+and may set
+.IR errno
+to indicate the error.
+In no case shall the value returned be greater than
+.IR n
+or the value of the
+{MB_CUR_MAX}
+macro.
+.SH ERRORS
+The
+\fImblen\fR()
+function may fail if:
+.TP
+.BR EILSEQ
+An invalid character sequence is detected. In the POSIX locale an
+.BR [EILSEQ]
+error cannot occur since all byte values are valid characters.
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "APPLICATION USAGE"
+None.
+.SH RATIONALE
+None.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fImbtowc\fR\^(\|)",
+.IR "\fImbstowcs\fR\^(\|)",
+.IR "\fIwctomb\fR\^(\|)",
+.IR "\fIwcstombs\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<stdlib.h>\fP"
+.\"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1-2017, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, 2018 Edition,
+Copyright (C) 2018 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+In the event of any discrepancy between this version and the original IEEE and
+The Open Group Standard, the original IEEE and The Open Group Standard
+is the referee document. The original Standard can be obtained online at
+http://www.opengroup.org/unix/online.html .
+.PP
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .