std::c32rtomb

std::size_t c32rtomb( char* s, char32_t c32, std::mbstate_t* ps );

Converts a UTF-32 character to its narrow multibyte representation.

If s is not a null pointer, the function determines the number of bytes necessary to store the multibyte character representation of c32 (including any shift sequences), and stores the multibyte character representation in the character array whose first element is pointed to by s. At most MB_CUR_MAX bytes can be written by this function.

If s is a null pointer, the call is equivalent to std::c32rtomb(buf, U'\0', ps) for some internal buffer buf.

If c32 is the null wide character U'\0', a null byte is stored, preceded by any shift sequence necessary to restore the initial shift state and the conversion state parameter *ps is updated to represent the initial shift state.

The multibyte encoding used by this function is specified by the currently active C locale.

Parameters

Return value

On success, returns the number of bytes (including any shift sequences) written to the character array whose first element is pointed to by s. This value may be ​0​, e.g. when processing the first char32_t in multi-char32_t-character sequence (does not occur in UTF-32).

On failure (if c32 is not a valid 32-bit character), returns -1, stores EILSEQ in errno, and leaves *ps in unspecified state.

Example

#include <iostream>
#include <iomanip>
#include <clocale>
#include <cuchar>
#include <cstdlib>
 
int main()
{
    std::setlocale(LC_ALL, "en_US.utf8");
    std::u32string str = U"zß水🍌"; // or z\u00df\u6c34\U0001F34C
    std::cout << "Processing " << str.size() << " UTF-32 code units: [ ";
    for(char32_t c : str) std::cout << std::showbase << std::hex << c << ' ';
    std::cout << "]\n";
 
    std::mbstate_t state{};
    std::string out(MB_CUR_MAX, '\0');
    for(size_t n = 0; n < str.size(); ++n)
    {
        int rc = std::c32rtomb(&out[0], str[n], &state);
        std::cout << str[n] << " converted to [ ";
        for(int x = 0; x < rc; ++x) std::cout << +(unsigned char)out[x] << ' ';
        std::cout << "]\n";
    }
}

Processing 4 UTF-32 code units: [ 0x7a 0xdf 0x6c34 0x1f34c ]
0x7a converted to [ 0x7a ]
0xdf converted to [ 0xc3 0x9f ]
0x6c34 converted to [ 0xe6 0xb0 0xb4 ]
0x1f34c converted to [ 0xf0 0x9f 0x8d 0x8c ]

See also