.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
+.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
.\" 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.
+.\" %%%LICENSE_END
.\"
.\" References consulted:
.\" GNU glibc-2 source code and manual
.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
.\" ISO/IEC 9899:1999
.\"
-.TH WCSTOMBS 3 1999-07-25 "GNU" "Linux Programmer's Manual"
+.TH WCSTOMBS 3 2019-03-06 "GNU" "Linux Programmer's Manual"
.SH NAME
wcstombs \- convert a wide-character string to a multibyte string
.SH SYNOPSIS
.nf
.B #include <stdlib.h>
-.sp
+.PP
.BI "size_t wcstombs(char *" dest ", const wchar_t *" src ", size_t " n );
.fi
.SH DESCRIPTION
-If \fIdest\fP is not a NULL pointer, the
+If
+.I dest
+is not NULL, the
.BR wcstombs ()
function converts
-the wide-character string \fIsrc\fP to a multibyte string starting at
-\fIdest\fP.
-At most \fIn\fP bytes are written to \fIdest\fP.
-The conversion
-starts in the initial state.
+the wide-character string
+.I src
+to a multibyte string starting at
+.IR dest .
+At most
+.I n
+bytes are written to
+.IR dest .
+The sequence of characters placed in
+.IR dest
+begins in the initial shift state.
The conversion can stop for three reasons:
-.PP
-1. A wide character has been encountered that can not be represented as a
+.IP 1. 3
+A wide character has been encountered that can not be represented as a
multibyte sequence (according to the current locale).
-In this case
+In this case,
.I (size_t)\ \-1
is returned.
+.IP 2.
+The length limit forces a stop.
+In this case, the number of bytes written to
+.I dest
+is returned, but the shift state at this point is lost.
+.IP 3.
+The wide-character string has been completely converted, including the
+terminating null wide character (L\(aq\e0\(aq).
+In this case, the conversion ends in the initial shift state.
+The number of bytes written to
+.IR dest ,
+excluding the terminating null byte (\(aq\e0\(aq), is returned.
.PP
-2. The length limit forces a stop.
-In this case the number of bytes written to
-\fIdest\fP is returned, but the shift state at this point is lost.
-.PP
-3. The wide-character string has been completely converted, including the
-terminating L\(aq\\0\(aq.
-In this case the conversion ends in the initial state.
-The number of bytes written to \fIdest\fP,
-excluding the terminating \(aq\\0\(aq byte, is returned.
+The programmer must ensure that there is room for at least
+.I n
+bytes
+at
+.IR dest .
.PP
-The programmer must ensure that there is room for at least \fIn\fP bytes
-at \fIdest\fP.
-.PP
-If \fIdest\fP is NULL, \fIn\fP is ignored, and the conversion proceeds as
+If
+.IR dest
+is NULL,
+.I n
+is ignored, and the conversion proceeds as
above, except that the converted bytes are not written out to memory,
-and that no length limit exists.
+and no length limit exists.
.PP
-In order to avoid the case 2 above, the programmer should make sure \fIn\fP
-is greater or equal to \fIwcstombs(NULL,src,0)+1\fP.
-.SH "RETURN VALUE"
+In order to avoid the case 2 above, the programmer should make sure
+.I n
+is greater than or equal to
+.IR "wcstombs(NULL,src,0)+1" .
+.SH RETURN VALUE
The
.BR wcstombs ()
function returns the number of bytes that make up the
-converted part of multibyte sequence, not including the terminating null byte.
+converted part of a multibyte sequence,
+not including the terminating null byte.
If a wide character was encountered which could not be
converted,
.I (size_t)\ \-1
is returned.
-.SH "CONFORMING TO"
-C99.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface Attribute Value
+T{
+.BR wcstombs ()
+T} Thread safety MT-Safe
+.TE
+.sp 1
+.SH CONFORMING TO
+POSIX.1-2001, POSIX.1-2008, C99.
.SH NOTES
The behavior of
.BR wcstombs ()
.PP
The function
.BR wcsrtombs (3)
-provides a thread safe interface to
-the same functionality.
-.SH "SEE ALSO"
+provides a better interface to the same functionality.
+.SH SEE ALSO
+.BR mblen (3),
+.BR mbstowcs (3),
+.BR mbtowc (3),
.BR wcsrtombs (3)
+.BR wctomb (3)
projects / thirdparty / man-pages.git / blobdiff