size_t mbstowcs ( wchar_t * wcstr, const char * mbstr, size_t max ); |
<cstdlib> |
Convert multibyte string to wide-character string
The C multibyte character string mbstr is interpreted character by character and translated to its wchar_t equivalent, which is stored in the location pointed by wcstr. The length in characters of the resulting string, not including the ending null-character, is returned.
Parameters
- wcstr
- Pointer to an array of wchar_t elements long enough to store a wide string max characters long.
- mbstr
- C multibyte character string to be interpreted.
- max
- Maximum number of wchar_t characters to be interpreted.
Return Value
The number of characters translated, not including the ending null-character.
If an invalid multibyte character is encountered, a
-1 value is returned.
See also
| mblen | Get length of multibyte character (function) |
| mbtowc | Convert multibyte character to wide character (function) |
| wcstombs | Convert wide-character string to multibyte string (function) |
