c32rtomb - cppreference.com

##### cppreference.com

##### Search

Create account

##### Namespaces

- Page
- Discussion

##### Variants

##### Views

- View
- Edit
- History

##### Actions

# c32rtomb

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

Defined in header `<uchar.h>` |  |
size_t c32rtomb( char* s, char32_t c32, mbstate_t* ps ); |  | (since C11)

Converts a 32-bit 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 `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 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.

If the macro __STDC_UTF_32__ is defined, the 32-bit encoding used by this function is UTF-32, otherwise it is implementation-defined. In any case, the multibyte encoding used by this function is specified by the currently active C locale.

### [edit] Parameters

s | - | pointer to narrow character array where the multibyte character will be stored
c32 | - | the 32-bit 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`. 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.

### [edit] Example

Run this code

    #include <stdio.h>
    #include <locale.h>
    #include <uchar.h>
    #include <stdlib.h>

    mbstate_t state;
    int main(void)
    {
        setlocale(LC_ALL, "en_US.utf8");
        char32_t str[] = U"zß水🍌"; // or z\u00df\u6c34\U0001F34C
        size_t str_sz = sizeof str / sizeof *str;

        printf("Processing %zu UCS-4 code units: [ ", str_sz);
        for(size_t n = 0; n < str_sz; ++n) printf("%#x ", str[n]); puts("]");

        char out[MB_CUR_MAX];
        for(size_t n = 0; n < str_sz; ++n)
        {
            int rc = c32rtomb(out, str[n], &state);
            printf("%#x converted to [ ", str[n]);
            for(int x = 0; x < rc; ++x) printf("%#x ", (unsigned char)out[x]); puts("]");
        }
    }

Output:

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

### [edit] References

- C11 standard (ISO/IEC 9899:2011):

  - 7.28.1.4 The c32rtomb function (p: 401)

### [edit] See also

mbrtoc32 (C11) | generate the next 32-bit wide character from a narrow multibyte string (function) [edit]
C++ documentation for c32rtomb

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=c/string/multibyte/c32rtomb&oldid=76795"