libwchar2 0.0.10
|
wcsrtombs - convert a wide-character string to a multibyte string
If dest is not NULL
, the wcsrtombs() function converts the wide-charac- ter string *src to a multibyte string starting at dest. At most len bytes are written to dest. The shift state *ps is updated. The con- version is effectively performed by repeatedly calling wcrtomb(dest, src, ps), as long as this call succeeds, and then incrementing dest by the number of bytes written and *src by one. The conversion can stop for three reasons:
(size_t) -1
is returned, and errno is set to EILSEQ
.L
'\0', which has the side effect of bringing back *ps to the initial state. In this case, src is set to NULL
, and the number of bytes written to dest, excluding the terminating null byte '\0', is returned.If dest is NULL
, len is ignored, and the conversion proceeds as above, except that the converted bytes are not written out to memory, and that no length limit exists.
In both of the above cases, if ps is NULL
, a static anonymous state known only to the wcsrtombs() function is used instead.
The programmer must ensure that there is room for at least len bytes at dest.
The wcsrtombs() function returns the number of bytes that make up the converted part of multibyte sequence, not including the terminating null byte. If a wide character was encountered which could not be con- verted, (size_t) -1
is returned, and errno set to EILSEQ
.
The behavior of wcsrtombs() depends on the LC_CTYPE
category of the current locale.
Passing NULL
as ps is not multithread safe.