diff options
Diffstat (limited to 'upstream/mageia-cauldron/man3p/mbrtowc.3p')
| -rw-r--r-- | upstream/mageia-cauldron/man3p/mbrtowc.3p | 185 |
1 files changed, 185 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man3p/mbrtowc.3p b/upstream/mageia-cauldron/man3p/mbrtowc.3p new file mode 100644 index 00000000..49e84228 --- /dev/null +++ b/upstream/mageia-cauldron/man3p/mbrtowc.3p @@ -0,0 +1,185 @@ +'\" et +.TH MBRTOWC "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 +mbrtowc +\(em convert a character to a wide-character code (restartable) +.SH SYNOPSIS +.LP +.nf +#include <wchar.h> +.P +size_t mbrtowc(wchar_t *restrict \fIpwc\fP, const char *restrict \fIs\fP, + size_t \fIn\fP, mbstate_t *restrict \fIps\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 a null pointer, the +\fImbrtowc\fR() +function shall be equivalent to the call: +.sp +.RS 4 +.nf + +mbrtowc(NULL, "", 1, ps) +.fi +.P +.RE +.P +In this case, the values of the arguments +.IR pwc +and +.IR n +are ignored. +.P +If +.IR s +is not a null pointer, the +\fImbrtowc\fR() +function shall inspect at most +.IR n +bytes beginning at the byte pointed to by +.IR s +to determine the number of bytes needed to complete the next character +(including any shift sequences). If the function determines that the +next character is completed, it shall determine the value of the +corresponding wide character and then, if +.IR pwc +is not a null pointer, shall store that value in the object pointed to by +.IR pwc . +If the corresponding wide character is the null wide character, the +resulting state described shall be the initial conversion state. +.P +If +.IR ps +is a null pointer, the +\fImbrtowc\fR() +function shall use its own internal +.BR mbstate_t +object, which shall be initialized at program start-up to the initial +conversion state. Otherwise, the +.BR mbstate_t +object pointed to by +.IR ps +shall be used to completely describe the current conversion state of +the associated character sequence. The implementation shall behave as +if no function defined in this volume of POSIX.1\(hy2017 calls +\fImbrtowc\fR(). +.P +The behavior of this function is affected by the +.IR LC_CTYPE +category of the current locale. +.P +The +\fImbrtowc\fR() +function need not be thread-safe if called with a NULL +.IR ps +argument. +.P +The +\fImbrtowc\fR() +function shall not change the setting of +.IR errno +if successful. +.SH "RETURN VALUE" +The +\fImbrtowc\fR() +function shall return the first of the following that applies: +.IP 0 12 +If the next +.IR n +or fewer bytes complete the character that corresponds to the null wide +character (which is the value stored). +.IP "between 1 and \fIn\fR inclusive" 12 +.br +If the next +.IR n +or fewer bytes complete a valid character (which is the value stored); +the value returned shall be the number of bytes that complete the +character. +.IP "(\fBsize_t\fP)\-2" 12 +If the next +.IR n +bytes contribute to an incomplete but potentially valid character, and +all +.IR n +bytes have been processed (no value is stored). When +.IR n +has at least the value of the +{MB_CUR_MAX} +macro, this case can only occur if +.IR s +points at a sequence of redundant shift sequences (for implementations +with state-dependent encodings). +.IP "(\fBsize_t\fP)\-1" 12 +If an encoding error occurs, in which case the next +.IR n +or fewer bytes do not contribute to a complete and valid character (no +value is stored). In this case, +.BR [EILSEQ] +shall be stored in +.IR errno +and the conversion state is undefined. +.SH ERRORS +The +\fImbrtowc\fR() +function shall 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. +.P +The +\fImbrtowc\fR() +function may fail if: +.TP +.BR EINVAL +.IR ps +points to an object that contains an invalid conversion state. +.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 "\fImbsinit\fR\^(\|)", +.IR "\fImbsrtowcs\fR\^(\|)" +.P +The Base Definitions volume of POSIX.1\(hy2017, +.IR "\fB<wchar.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 . |