|
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 | STANDARDS | HISTORY | NOTES | SEE ALSO | COLOPHON |
|
|
|
wcrtomb(3) Library Functions Manual wcrtomb(3)
wcrtomb - convert a wide character to a multibyte sequence
Standard C library (libc, -lc)
#include <wchar.h>
size_t wcrtomb(char *restrict s, wchar_t wc, mbstate_t *restrict ps);
The main case for this function is when s is not NULL and wc is
not a null wide character (L'\0'). In this case, the wcrtomb()
function converts the wide character wc to its multibyte
representation and stores it at the beginning of the character
array pointed to by s. It updates the shift state *ps, and
returns the length of said multibyte representation, that is, the
number of bytes written at s.
A different case is when s is not NULL, but wc is a null wide
character (L'\0'). In this case, the wcrtomb() function stores
at the character array pointed to by s the shift sequence needed
to bring *ps back to the initial state, followed by a '\0' byte.
It updates the shift state *ps (i.e., brings it into the initial
state), and returns the length of the shift sequence plus one,
that is, the number of bytes written at s.
A third case is when s is NULL. In this case, wc is ignored, and
the function effectively returns
wcrtomb(buf, L'\0', ps)
where buf is an internal anonymous buffer.
In all of the above cases, if ps is NULL, a static anonymous
state known only to the wcrtomb() function is used instead.
The wcrtomb() function returns the number of bytes that have been
or would have been written to the byte array at s. If wc can not
be represented as a multibyte sequence (according to the current
locale), (size_t) -1 is returned, and errno set to EILSEQ.
For an explanation of the terms used in this section, see
attributes(7).
┌──────────────────┬───────────────┬────────────────────────────┐
│ Interface │ Attribute │ Value │
├──────────────────┼───────────────┼────────────────────────────┤
│ wcrtomb() │ Thread safety │ MT-Unsafe race:wcrtomb/!ps │
└──────────────────┴───────────────┴────────────────────────────┘
C11, POSIX.1-2008.
POSIX.1-2001, C99.
The behavior of wcrtomb() depends on the LC_CTYPE category of the
current locale.
Passing NULL as ps is not multithread safe.
mbsinit(3), wcsrtombs(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
man-pages@man7.org
Linux man-pages 6.9.1 2024-06-15 wcrtomb(3)
Pages that refer to this page: mbsinit(3), mbstate_t(3type), printf(3), wcsrtombs(3), wctob(3), wctomb(3)
|
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. |
|