命名空间
变体
操作

c16rtomb

来自 cppreference.cn
< c‎ | string‎ | multibyte
在头文件 <uchar.h> 中定义
size_t c16rtomb( char* restrict s, char16_t c16, mbstate_t* restrict ps );
(C11 起)

将单个码点从其可变长度的16位宽字符表示(通常是 UTF-16)转换为其窄多字节字符表示。

如果 s 不是空指针,并且 c16 是码点有效可变长度编码中的最后一个16位代码单元,则函数确定存储该码点多字节字符表示所需的字节数(包括任何移位序列,并考虑当前的多字节转换状态 *ps),并将多字节字符表示存储在第一个元素由 s 指向的字符数组中,同时根据需要更新 *ps。此函数最多可以写入 MB_CUR_MAX 字节。

如果 s 是空指针,则此调用等同于 c16rtomb(buf, u'\0', ps),其中 buf 是某个内部缓冲区。

如果 c16 是空宽字符 u'\0',则存储一个空字节,前面是任何必要的移位序列以恢复初始移位状态,并且转换状态参数 *ps 会更新以表示初始移位状态。

如果 c16 不是宽字符16位表示中的最后一个代码单元,则它不会写入 s 所指向的数组,只更新 *ps

如果宏 __STDC_UTF_16__ 已定义,则此函数使用的16位编码是 UTF-16;否则,它是实现定义的。该宏始终定义,编码始终是 UTF-16。(自 C23 起) 无论如何,此函数使用的多字节字符编码由当前活动的 C 语言环境指定。

目录

[编辑] 参数

s - 指向窄字符数组的指针,多字节字符将存储在此处
c16 - 要转换的16位宽字符
ps - 指向转换状态对象的指针,用于解释多字节字符串

[编辑] 返回值

成功时,返回写入到第一个元素由 s 指向的字符数组中的字节数(包括任何移位序列)。此值可能为 0,例如在处理多 char16_t 单元序列中的前导 char16_t 单元时(在处理 UTF-16 代理对中的前导代理时发生)。

失败时(如果 c16 不是有效的16位代码单元),返回 -1,将 EILSEQ 存储在 errno 中,并使 *ps 处于未指定状态。

[编辑] 注意

在已发布的 C11 中,与 mbrtoc16 不同,后者将可变宽度多字节(例如 UTF-8)转换为可变宽度16位(例如 UTF-16)编码,此函数只能转换单单元16位编码,这意味着它无法将 UTF-16 转换为 UTF-8,尽管这是此函数的最初意图。C11 后的缺陷报告 DR488 纠正了这一点。

[编辑] 示例

注意:此示例假定已应用缺陷报告 DR488 的修复。
在 MSVC 上,您可能需要 /utf-8 编译器标志才能使 UTF_8 正常工作。

#include <locale.h>
#include <stdio.h>
#include <stdlib.h>
#include <uchar.h>
 
int main(void)
{
    setlocale(LC_ALL, "en_US.utf8");
    const char16_t in[] = u"zß水🍌"; // or "z\u00df\u6c34\U0001F34C"
    const size_t in_sz = sizeof in / sizeof *in;
 
    printf("Processing %zu UTF-16 code units: [", in_sz);
    for (size_t n = 0; n < in_sz; ++n)
        printf("%s%04X", n ? " " : "", in[n]);
    puts("]");
 
    char* out = malloc(MB_CUR_MAX * in_sz);
    char* p = out;
    mbstate_t state = {0};
 
    for (size_t n = 0; n < in_sz; ++n)
    {
        size_t rc = c16rtomb(p, in[n], &state);
        if (rc == (size_t)-1)
            break;
        p += rc;
    }
 
    size_t out_sz = p - out;
    printf("into %zu UTF-8 code units: [", out_sz);
    for (size_t x = 0; x < out_sz; ++x)
        printf("%s%02X", x ? " " : "", +(unsigned char)out[x]);
    puts("]");
    free(out);
}

输出

Processing 6 UTF-16 code units: [007A 00DF 6C34 D83C DF4C 0000]
into 13 UTF-8 code units: [7A C3 9F E6 B0 B4 ED A0 BC ED BD 8C 00]

[编辑] 参考资料

  • C23 标准 (ISO/IEC 9899:2024)
  • 7.28.1.2 The c16rtomb function (p: TBD)
  • C17 标准 (ISO/IEC 9899:2018)
  • 7.28.1.2 The c16rtomb function (p: TBD)
  • C11 标准 (ISO/IEC 9899:2011)
  • 7.28.1.2 The c16rtomb function (p: 399-400)

[编辑] 参阅

将窄多字节字符转换为 UTF-16 编码
(function) [编辑]
C++ documentation for c16rtomb