.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
-.\" This is free documentation; you can redistribute it and/or
-.\" modify it under the terms of the GNU General Public License as
-.\" published by the Free Software Foundation; either version 2 of
-.\" the License, or (at your option) any later version.
+.\" SPDX-License-Identifier: GPL-2.0-or-later
.\"
.\" References consulted:
.\" GNU glibc-2 source code and manual
.\" Dinkumware C library reference http://www.dinkumware.com/
-.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
+.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
.\" ISO/IEC 9899:1999
.\"
-.TH MBSRTOWCS 3 1999-07-25 "GNU" "Linux Programmer's Manual"
+.TH MBSRTOWCS 3 (date) "Linux man-pages (unreleased)"
.SH NAME
mbsrtowcs \- convert a multibyte string to a wide-character string
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
.SH SYNOPSIS
.nf
.B #include <wchar.h>
-.sp
-.BI "size_t mbsrtowcs(wchar_t *" dest ", const char **" src ,
-.BI " size_t " len ", mbstate_t *" ps );
+.PP
+.BI "size_t mbsrtowcs(wchar_t *restrict " dest ", const char **restrict " src ,
+.BI " size_t " len ", mbstate_t *restrict " ps );
.fi
.SH DESCRIPTION
-If \fIdest\fP is not a NULL pointer, the
+If
+.I dest
+is not NULL, the
.BR mbsrtowcs ()
function converts the
-multibyte string \fI*src\fP to a wide-character string starting at \fIdest\fP.
-At most \fIlen\fP wide characters are written to \fIdest\fP.
+multibyte string
+.I *src
+to a wide-character string starting at
+.IR dest .
+At most
+.I len
+wide characters are written to
+.IR dest .
The shift state
-\fI*ps\fP is updated.
+.I *ps
+is updated.
The conversion is effectively performed by repeatedly
-calling mbrtowc(\fIdest\fP,\fI*src\fP,\fIn\fP,\fIps\fP) where \fIn\fP is some
+calling
+.I "mbrtowc(dest, *src, n, ps)"
+where
+.I n
+is some
positive number, as long as this call succeeds, and then incrementing
-\fIdest\fP by one and \fI*src\fP by the number of bytes consumed.
+.I dest
+by one and
+.I *src
+by the number of bytes consumed.
The conversion can stop for three reasons:
-.PP
-1. An invalid multibyte sequence has been encountered.
-In this case \fI*src\fP
-is left pointing to the invalid multibyte sequence, (size_t)(\-1) is returned,
-and \fIerrno\fP is set to \fBEILSEQ\fP.
-.PP
-2. \fIlen\fP non-L'\\0' wide characters have been stored at \fIdest\fP.
-In this
-case \fI*src\fP is left pointing to the next multibyte sequence to be converted,
-and the number of wide characters written to \fIdest\fP is returned.
-.PP
-3. The multibyte string has been completely converted, including the
-terminating '\\0' (which has the side effect of bringing back \fI*ps\fP to the
-initial state).
-In this case \fI*src\fP is set to NULL, and the number of wide
-characters written to \fIdest\fP, excluding the terminating L'\\0' character,
+.IP 1. 3
+An invalid multibyte sequence has been encountered.
+In this case,
+.I *src
+is left pointing to the invalid multibyte sequence,
+.I (size_t)\ \-1
+is returned,
+and
+.I errno
+is set to
+.BR EILSEQ .
+.IP 2.
+.I len
+non-L\(aq\e0\(aq wide characters have been stored at
+.IR dest .
+In this case,
+.I *src
+is left pointing to the next
+multibyte sequence to be converted,
+and the number of wide characters written to
+.I dest
is returned.
+.IP 3.
+The multibyte string has been completely converted, including the
+terminating null wide character (\(aq\e0\(aq), which has the side
+effect of bringing back
+.I *ps
+to the
+initial state.
+In this case,
+.I *src
+is set to NULL, and the number of wide
+characters written to
+.IR dest ,
+excluding the terminating null wide character, is returned.
.PP
-If \fIdest\fP is NULL, \fIlen\fP is ignored, and the conversion proceeds as
-above, except that the converted wide characters are not written out to memory,
+If
+.I dest
+is NULL,
+.I len
+is ignored,
+and the conversion proceeds as above,
+except that the converted wide characters are not written out to memory,
and that no length limit exists.
.PP
-In both of the above cases, if \fIps\fP is a NULL pointer, a static anonymous
-state only known to the mbsrtowcs function is used instead.
+In both of the above cases,
+if
+.I ps
+is NULL, a static anonymous
+state known only to the
+.BR mbsrtowcs ()
+function is used instead.
.PP
-The programmer must ensure that there is room for at least \fIlen\fP wide
-characters at \fIdest\fP.
-.SH "RETURN VALUE"
+The programmer must ensure that there is room for at least
+.I len
+wide
+characters at
+.IR dest .
+.SH RETURN VALUE
The
.BR mbsrtowcs ()
function returns the number of wide characters that make
up the converted part of the wide-character string, not including the
terminating null wide character.
If an invalid multibyte sequence was
-encountered, (size_t)(\-1) is returned, and \fIerrno\fP set to \fBEILSEQ\fP.
-.SH "CONFORMING TO"
-C99
+encountered,
+.I (size_t)\ \-1
+is returned, and
+.I errno
+set to
+.BR EILSEQ .
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.ad l
+.nh
+.TS
+allbox;
+lb lb lbx
+l l l.
+Interface Attribute Value
+T{
+.BR mbsrtowcs ()
+T} Thread safety T{
+MT-Unsafe race:mbsrtowcs/!ps
+T}
+.TE
+.hy
+.ad
+.sp 1
+.SH STANDARDS
+POSIX.1-2001, POSIX.1-2008, C99.
.SH NOTES
The behavior of
.BR mbsrtowcs ()
category of the
current locale.
.PP
-Passing NULL as \fIps\fP is not multi-thread safe.
-.SH "SEE ALSO"
+Passing NULL as
+.I ps
+is not multithread safe.
+.SH SEE ALSO
.BR iconv (3),
+.BR mbrtowc (3),
+.BR mbsinit (3),
.BR mbsnrtowcs (3),
.BR mbstowcs (3)
projects / thirdparty / man-pages.git / blobdiff