Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

wctomb(3) [xfree86 man page]

WCTOMB(3)						     Linux Programmer's Manual							 WCTOMB(3)

NAME
wctomb - convert a wide character to a multibyte sequence SYNOPSIS
#include <stdlib.h> int wctomb(char *s, wchar_t wc); DESCRIPTION
If s is not NULL, the wctomb() 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, which is stored in a static anonymous variable known only to the wctomb() function, and returns the length of said multibyte representation, that is, the number of bytes written at s. The programmer must ensure that there is room for at least MB_CUR_MAX bytes at s. If s is NULL, the wctomb() function resets the shift state, known only to this function, to the initial state, and returns nonzero if the encoding has nontrivial shift state, or zero if the encoding is stateless. RETURN VALUE
If s is not NULL, the wctomb() function returns the number of bytes that have been written to the byte array at s. If wc can not be repre- sented as a multibyte sequence (according to the current locale), -1 is returned. If s is NULL, the wctomb() function returns nonzero if the encoding has nontrivial shift state, or zero if the encoding is stateless. ATTRIBUTES
For an explanation of the terms used in this section, see attributes(7). +----------+---------------+----------------+ |Interface | Attribute | Value | +----------+---------------+----------------+ |wctomb() | Thread safety | MT-Unsafe race | +----------+---------------+----------------+ CONFORMING TO
POSIX.1-2001, POSIX.1-2008, C99. NOTES
The behavior of wctomb() depends on the LC_CTYPE category of the current locale. The function wcrtomb(3) provides a better interface to the same functionality. SEE ALSO
MB_CUR_MAX(3), mblen(3), mbstowcs(3), mbtowc(3), wcrtomb(3), wcstombs(3) COLOPHON
This page is part of release 4.15 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/. GNU
2015-08-08 WCTOMB(3)

Check Out this Related Man Page

MBTOWC(3)						     Linux Programmer's Manual							 MBTOWC(3)

NAME
mbtowc - convert a multibyte sequence to a wide character SYNOPSIS
#include <stdlib.h> int mbtowc(wchar_t *pwc, const char *s, size_t n); DESCRIPTION
The main case for this function is when s is not NULL and pwc is not NULL. In this case, the mbtowc() function inspects at most n bytes of the multibyte string starting at s, extracts the next complete multibyte character, converts it to a wide character and stores it at *pwc. It updates an internal shift state known only to the mbtowc() function. If s does not point to a null byte (''), it returns the number of bytes that were consumed from s, otherwise it returns 0. If the n bytes starting at s do not contain a complete multibyte character, or if they contain an invalid multibyte sequence, mbtowc() returns -1. This can happen even if n >= MB_CUR_MAX, if the multibyte string contains redundant shift sequences. A different case is when s is not NULL but pwc is NULL. In this case, the mbtowc() function behaves as above, except that it does not store the converted wide character in memory. A third case is when s is NULL. In this case, pwc and n are ignored. The mbtowc() function resets the shift state, only known to this function, to the initial state, and returns nonzero if the encoding has nontrivial shift state, or zero if the encoding is stateless. RETURN VALUE
If s is not NULL, the mbtowc() function returns the number of consumed bytes starting at s, or 0 if s points to a null byte, or -1 upon failure. If s is NULL, the mbtowc() function returns nonzero if the encoding has nontrivial shift state, or zero if the encoding is stateless. ATTRIBUTES
For an explanation of the terms used in this section, see attributes(7). +----------+---------------+----------------+ |Interface | Attribute | Value | +----------+---------------+----------------+ |mbtowc() | Thread safety | MT-Unsafe race | +----------+---------------+----------------+ CONFORMING TO
POSIX.1-2001, POSIX.1-2008, C99. NOTES
The behavior of mbtowc() depends on the LC_CTYPE category of the current locale. This function is not multithread safe. The function mbrtowc(3) provides a better interface to the same functionality. SEE ALSO
MB_CUR_MAX(3), mblen(3), mbrtowc(3), mbstowcs(3), wcstombs(3), wctomb(3) COLOPHON
This page is part of release 4.15 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/. GNU
2016-10-08 MBTOWC(3)
Man Page