std::wcrtomb - cppreference.com

##### cppreference.com

##### Search

Create account

##### Namespaces

- Page
- Discussion

##### Variants

##### Views

- View
- Edit
- History

##### Actions

# std::wcrtomb

From cppreference.com
< cpp‎ | string‎ | multibyte

Defined in header `<cwchar>` |  |
std::size_t wcrtomb( char* s, wchar_t wc, std::mbstate_t* ps ); |  |

Converts a wide 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 `wc` (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::wcrtomb(buf, L'\0', ps) for some internal buffer `buf`.

If wc is the null wide character L'\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.

### [edit] Parameters

s | - | pointer to narrow character array where the multibyte character will be stored
wc | - | the wide character to convert
ps | - | pointer to the conversion state object used when interpreting the multibyte string

### [edit] 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`.

On failure (if wc is not a valid wide character), returns static_cast<std::size_t>(-1), stores EILSEQ in errno, and leaves *ps in unspecified state.

### [edit] Example

Run this code

    #include <iostream>
    #include <clocale>
    #include <string>
    #include <cwchar>

    void print_wide(const std::wstring& wstr)
    {
        std::mbstate_t state = std::mbstate_t();
        for(wchar_t wc : wstr) {
            std::string mb(MB_CUR_MAX, '\0');
            int ret = std::wcrtomb(&mb[0], wc, &state);
            std::cout << "multibyte char " << mb << " is " << ret << " bytes\n";
        }
    }

    int main()
    {
        std::setlocale(LC_ALL, "en_US.utf8");
        // UTF-8 narrow multibyte encoding
        std::wstring wstr = L"z\u00df\u6c34\U0001d10b"; // or L"zß水𝄋"
        print_wide(wstr);
    }

Output:

    multibyte char z is 1 bytes
    multibyte char ß is 2 bytes
    multibyte char 水 is 3 bytes
    multibyte char 𝄋 is 4 bytes

### [edit] See also

wctomb | converts a wide character to its multibyte representation (function) [edit]
mbrtowc | converts the next multibyte character to wide character, given state (function) [edit]
do_out [virtual] | converts a string from internT to externT, such as when writing to file (virtual protected member function of `std::codecvt`) [edit]
C documentation for wcrtomb

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=cpp/string/multibyte/wcrtomb&oldid=59069"