wctomb
Defined in header <stdlib.h>
|
||
int wctomb( char* s, wchar_t wc ); |
||
Converts a wide character wc to multibyte encoding and stores it (including any shift sequences) in the char array whose first element is pointed to by s. No more than MB_CUR_MAX characters are stored.
If wc is the null character, the null byte is written to s, preceded by any shift sequences necessary to restore the initial shift state.
If s is a null pointer, resets the global conversion state and determines whether shift sequences are used.
Contents |
[edit] Notes
Each call to wctomb updates the internal global conversion state (a static object of type mbstate_t, only known to this function). If the multibyte encoding uses shift states, this function is not reentrant. In any case, multiple threads should not call wctomb without synchronization: wcrtomb may be used instead.
[edit] Parameters
s | - | pointer to the character array for output |
wc | - | wide character to convert |
[edit] Return value
If s is not a null pointer, returns the number of bytes that are contained in the multibyte representation of wc or -1 if wc is not a valid character.
If s is a null pointer, resets its internal conversion state to represent the initial shift state and returns 0 if the current multibyte encoding is not state-dependent (does not use shift sequences) or a non-zero value if the current multibyte encoding is state-dependent (uses shift sequences).
[edit] Example
This section is incomplete Reason: no example |
[edit] See also
converts the next multibyte character to wide character (function) | |
converts a wide character to its multibyte representation, given state (function) | |
C++ documentation for wctomb
|