std::mbrtoc16
Template:cpp/string/multibyte/sidebar
| Defined in header <cuchar>
|
||
| std::size_t mbrtoc32( char32_t* pc16, const char* s, |
(since C++11) | |
Converts a narrow multibyte character to its 32-bit character representation (typically, UTF-32).
If s is not a null pointer, inspects at most n bytes of the multibyte character string, beginning with the byte pointed to by s to determine the number of bytes necessary to complete the next multibyte character (including any shift sequences). If the function determines that the next multibyte character in s is complete and valid, converts it to the corresponding 32-bit character and stores it in Template:cpp (if pc32 is not null).
If the multibyte character in *s corresponds to a multi-char32_t sequence (not possible with UTF-32), then after the first call to this function, *ps is updated in such a way that the next calls to mbrtoc32 will write out the additional char32_t, without considering *s.
If s is a null pointer, the values of n and pc32 are ignored and the call is equivalent to Template:cpp.
If the wide character produced is the null character, the conversion state Template:cpp represents the initial shift state.
If the macro Template:cpp is defined, the 32-bit encoding used by this function is UTF-32, otherwise it is implementation-defined.
Parameters
| pc32 | - | pointer to the location where the resulting 32-bit character will be written |
| s | - | pointer to the multibyte character string used as input |
| n | - | limit on the number of bytes in s that can be examined |
| ps | - | pointer to the conversion state object used when interpreting the multibyte string |
Return value
The first of the following that applies:
- Template:cpp if the character converted from
s(and stored in Template:cpp if non-null) was the null character - the number of bytes Template:cpp of the multibyte character successfully converted from
s - Template:cpp if the next Template:cpp from a multi-Template:cpp character has now been written to Template:cpp. No bytes are processed from the input in this case.
- Template:cpp if the next
nbytes constitute an incomplete, but so far valid, multibyte character. Nothing is written to Template:cpp. - Template:cpp if encoding error occurs. Nothing is written to
*pc32, the value Template:cpp is stored in Template:cpp and the value if Template:cpp is unspecified.
