|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|
|
NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ATTRIBUTES | VERSIONS | STANDARDS | HISTORY | NOTES | SEE ALSO | COLOPHON |
|
|
|
wcstombs(3) Library Functions Manual wcstombs(3)
wcstombs - convert a wide-character string to a multibyte string
Standard C library (libc, -lc)
#include <stdlib.h>
size_t wcstombs(char dest[restrict .n], const wchar_t *restrict src,
size_t n);
If dest is not NULL, the wcstombs() function converts the wide-
character string src to a multibyte string starting at dest. At
most n bytes are written to dest. The sequence of characters
placed in dest begins in the initial shift state. The conversion
can stop for three reasons:
• A wide character has been encountered that can not be
represented as a multibyte sequence (according to the current
locale). In this case, (size_t) -1 is returned.
• The length limit forces a stop. In this case, the number of
bytes written to dest is returned, but the shift state at this
point is lost.
• The wide-character string has been completely converted,
including the terminating null wide character (L'\0'). In
this case, the conversion ends in the initial shift state.
The number of bytes written to dest, excluding the terminating
null byte ('\0'), is returned.
The programmer must ensure that there is room for at least n
bytes at dest.
If dest is NULL, n is ignored, and the conversion proceeds as
above, except that the converted bytes are not written out to
memory, and no length limit exists.
In order to avoid the case 2 above, the programmer should make
sure n is greater than or equal to wcstombs(NULL,src,0)+1.
The wcstombs() function returns the number of bytes that make up
the converted part of a multibyte sequence, not including the
terminating null byte. If a wide character was encountered which
could not be converted, (size_t) -1 is returned.
For an explanation of the terms used in this section, see
attributes(7).
┌─────────────────────────────────────┬───────────────┬─────────┐
│ Interface │ Attribute │ Value │
├─────────────────────────────────────┼───────────────┼─────────┤
│ wcstombs() │ Thread safety │ MT-Safe │
└─────────────────────────────────────┴───────────────┴─────────┘
The function wcsrtombs(3) provides a better interface to the same
functionality.
C11, POSIX.1-2008.
POSIX.1-2001, C99.
The behavior of wcstombs() depends on the LC_CTYPE category of
the current locale.
mblen(3), mbstowcs(3), mbtowc(3), wcsrtombs(3), wctomb(3)
This page is part of the man-pages (Linux kernel and C library
user-space interface documentation) project. Information about
the project can be found at
⟨https://www.kernel.org/doc/man-pages/⟩. If you have a bug report
for this manual page, see
⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
This page was obtained from the tarball man-pages-6.9.1.tar.gz
fetched from
⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
2024-06-26. If you discover any rendering problems in this HTML
version of the page, or you believe there is a better or more up-
to-date source for the page, or you have corrections or
improvements to the information in this COLOPHON (which is not
part of the original manual page), send a mail to
[email protected]
Linux man-pages 6.9.1 2024-06-15 wcstombs(3)
Pages that refer to this page: MB_CUR_MAX(3), mbstowcs(3), mbtowc(3), wcsrtombs(3), wctomb(3), locale(7)
|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|