wctomb3
Convert a wide-character code to a character
Usage
#include <stdlib.h>
int
wctomb(char *s, wchar_t wchar);
#include <stdlib.h>
#include <xlocale.h>
int
wctomb_l(char *s, wchar_t wchar, locale_t loc);
Library
Standard C Library (libc, -lc)
Overview
The wctomb() function converts a wide character, wchar, into a multibyte character and stores the result in s. The object pointed to by s must be large enough to accommodate the multibyte character, which may be up to MB_LEN_MAX bytes.
A call with a null s pointer returns nonzero if the current locale requires shift states, zero otherwise; if shift states are required, the shift state is reset to the initial state.
Although the wctomb() function uses the current locale, the wctomb_l() function may be passed a locale directly. See xlocale(3) for more information.
Return values
If s is NULL, the wctomb() function returns nonzero if shift states are supported, zero otherwise. If s is valid, wctomb() returns the number of bytes processed in s, or -1 if no multibyte character could be recognized or converted. In this case, wctomb(Ns, 's) internal conversion state is undefined.
Errors
The wctomb() function will fail if:
- [EILSEQ]
-
An invalid multibyte sequence was detected.
- [EINVAL]
-
The internal conversion state is invalid.
Releases
135 releases since Mac OS X 10.4; the text changed 2 times.