The
wcsrtombs() converts the nul-terminated wide character string indirectly pointed to by
pwcs to the corresponding multibyte character string, and stores it in the array pointed to by
s. The conversion stops due to the following reasons:
•
The conversion reaches a nul wide character. In this case, the nul wide character is also converted.
•
The wcsrtombs() has already stored n bytes in the array pointed to by s.
•
The conversion encounters an invalid character.
Each character will be converted as if
wcrtomb(3) is continuously called, except the internal state of
wcrtomb(3) will not be affected.
After conversion, if
s is not a null pointer, the pointer object pointed to by
pwcs is a null pointer (if the conversion is stopped due to reaching a nul wide character) or the first byte of the character just after the last character converted.
If
s is not a null pointer and the conversion is stopped due to reaching a nul wide character,
wcsrtombs() places the state object pointed to by
ps to an initial state after the conversion is taken place.
The behaviour of
wcsrtombs() is affected by the
LC_CTYPE category of the current locale.
These are the special cases:
s == NULL
wcsrtombs() returns the number of bytes to store the whole multibyte character string corresponding to the wide character string pointed to by pwcs, not including the terminating nul byte. In this case, n is ignored.
pwcs == NULL || *pwcs == NULL
Undefined (may cause the program to crash).
ps == NULL
wcsrtombs() uses its own internal state object to keep the conversion state, instead of
ps mentioned in this manual page.
Calling any other functions in
Standard C Library (libc, -lc) never changes the internal state of
wcsrtombs(), which is initialized at startup time of the program.