从变长 16 位宽字符表示（典型地为 UTF-16 ）转换单个编码点到其窄多字节字符表示。

若 s 不是空指针且 c16 是合法的编码点变长编码中的最后一个 16 位编码单元，则函数确定存储该编码点所需的字节数（包含任何迁移序列，并考虑当前多字节转换状态 *ps ），并存储多字节表示于首元素为 s 所指向的字符数组，若必要则更新 *ps 。此函数最能写入 MB_CUR_MAX 个字节。

若 s 是空指针，则调用等价于对于某内部缓冲区 buf 的 std::c16rtomb(buf, u'\0', ps) 。

若 c16 是空宽字符 u'\0' ，则存储空字节，前附恢复到初始迁移状态所需的任何迁移序列，并更新 *ps 以表示初始迁移状态。

若 c16 不是宽字符的 16 位表示中最终编码单元，则不写入 s 所指向的数组，只更新 *ps 。

此函数所用的宽字符编码为当前活跃的 C 本地环境所指定。

参数

返回值

成功时，返回写入首元素为 s 所指向的字符数组的字节数（包含任何迁移序列）。此值可以是 ​0​ ，例如在处理多 char16_t 单元序列的前导 char16_t 单元时（在处理 UTF-16 代理对中的前导代理时出现）。

失败时（若 c16 不是合法的 16 位编码单元），则返回 -1 ，并存储 EILSEQ 于 errno ，把 *ps 置于未指定状态。

注意

C++ 标准将此函数的语义委派到 C 标准。在 C11 刚发布时，不同于转换变宽多字节（如 UTF-8 ）到变宽 16 位（如 UTF-16 ）编码的 std::mbrtoc16 ，此函数只能转换单个单元的 16 位编码，这表示尽管此函数的原目的如此，它仍不能转换 UTF-16 到 UTF-8 。这为 C11 后的缺陷报告 DR488 所更正。

示例

#include <iostream>
#include <iomanip>
#include <string_view>
#include <clocale>
#include <cuchar>
#include <climits>
 
int main()
{
    std::setlocale(LC_ALL, "en_US.utf8");
    std::u16string_view strv = u"zß水🍌"; // 或 z\u00df\u6c34\U0001F34C
    std::cout << "Processing " << strv.size() << " UTF-16 code units: [ ";
    for(char16_t c : strv)
        std::cout << std::showbase << std::hex << c << ' ';
    std::cout << "]\n";
 
    std::mbstate_t state{};
    char out[MB_LEN_MAX]{};
    for(char16_t c : strv)
    {   
        std::size_t rc = std::c16rtomb(out, c, &state);
        std::cout << c << " converted to [ ";
        if(rc != (std::size_t)-1)
            for(unsigned char c8 : std::string_view{out, rc})
                std::cout << +c8 << ' ';
        std::cout << "]\n";
    }
}

Processing 5 UTF-16 code units: [ 0x7a 0xdf 0x6c34 0xd83c 0xdf4c ]
0x7a converted to [ 0x7a ]
0xdf converted to [ 0xc3 0x9f ]
0x6c34 converted to [ 0xe6 0xb0 0xb4 ]
0xd83c converted to [ ]
0xdf4c converted to [ 0xf0 0x9f 0x8d 0x8c ]

参阅