命名空间
变体
操作

mbstowcs, mbstowcs_s

来自 cppreference.cn
< c‎ | string‎ | multibyte
在头文件 <stdlib.h> 中定义
(1)
size_t mbstowcs( wchar_t          *dst, const char          *src, size_t len)
(直到 C99)
size_t mbstowcs( wchar_t *restrict dst, const char *restrict src, size_t len)
(C99 起)
errno_t mbstowcs_s(size_t *restrict retval, wchar_t *restrict dst,
                  rsize_t dstsz, const char *restrict src, rsize_t len);
(2) (C11 起)
1) 将多字节字符串从src指向的数组转换为其宽字符表示。转换后的字符存储在dst指向的数组的后续元素中。写入目标数组的宽字符数不超过len
每个字符都如同通过调用mbtowc进行转换,但mbtowc的转换状态不受影响。转换在以下情况下停止:
* 多字节空字符已转换并存储。
* 遇到了无效(在当前C语言环境中)的多字节字符。
* 将要存储的下一个宽字符将超过len
如果srcdst重叠,则行为未定义。
2)(1)相同,但:
* 转换如同通过mbrtowc进行,而不是mbtowc
* 函数将其结果作为输出参数retval返回
* 如果在写入len个宽字符后没有空字符写入dst,则将L'\0'存储在dst[len]中,这意味着总共写入了len+1个宽字符
* 如果dst是空指针,则将生成多少宽字符存储在*retval
* 函数会从终止空字符到dstsz之间覆盖目标数组
* 如果srcdst重叠,则行为未指定。
* 以下错误在运行时检测到并调用当前安装的约束处理函数
  • retvalsrc为空指针
  • dstszlen大于RSIZE_MAX/sizeof(wchar_t)(除非dst为空)
  • dstsz不为零(除非dst为空)
  • src数组中的前dstsz个多字节字符中没有空字符,并且len大于dstsz(除非dst为空)
与所有边界检查函数一样,只有在实现定义了__STDC_LIB_EXT1__且用户在包含<stdlib.h>之前将__STDC_WANT_LIB_EXT1__定义为整数常量1时,才保证mbstowcs_s可用。

目录

[编辑] 注意

在大多数实现中,mbstowcs在处理字符串时会更新类型为mbstate_t的全局静态对象,并且不能由两个线程同时调用,在这种情况下应使用mbsrtowcs

POSIX指定了一个常见扩展:如果dst为空指针,此函数将返回如果转换将写入dst的宽字符数。mbstowcs_smbsrtowcs也有类似的标准行为。

[编辑] 参数

dst - 指向将存储宽字符串的宽字符数组的指针
src - 指向要转换的空终止多字节字符串的第一个元素的指针
len - dst指向的数组中可用的宽字符数
dstsz - 将写入的最大宽字符数(dst数组的大小)
retval - 指向一个size_t对象的指针,结果将存储在此处

[编辑] 返回值

1) 成功时,返回写入目标数组的宽字符数,不包括终止的L'\0'。在转换错误时(如果遇到无效的多字节字符),返回(size_t)-1
2) 成功时返回零(在这种情况下,写入dst的宽字符数,不包括终止零,将存储在*retval中),错误时返回非零。如果发生运行时约束违例,则在*retval中存储(size_t)-1(除非retval为空)并将dst[0]设置为L'\0'(除非dst为空或dstmax为零或大于RSIZE_MAX

[编辑] 示例

#include <stdio.h>
#include <locale.h>
#include <stdlib.h>
#include <wchar.h>
 
int main(void)
{
    setlocale(LC_ALL, "en_US.utf8");
    const char* mbstr = u8"z\u00df\u6c34\U0001F34C"; // or u8"zß水🍌"
    wchar_t wstr[5];
    mbstowcs(wstr, mbstr, 5);
    wprintf(L"MB string: %s\n", mbstr);
    wprintf(L"Wide string: %ls\n", wstr);
}

输出

MB string: zß水🍌
Wide string: zß水🍌

[编辑] 参考文献

  • C11 标准 (ISO/IEC 9899:2011)
  • 7.22.8.1 mbstowcs函数 (p: 359)
  • K.3.6.5.1 mbstowcs_s函数 (p: 611-612)
  • C99 标准 (ISO/IEC 9899:1999)
  • 7.20.8.1 mbstowcs函数 (p: 323)
  • C89/C90 标准 (ISO/IEC 9899:1990)
  • 4.10.8.1 mbstowcs函数

[编辑] 另请参阅

将窄多字节字符字符串转换为宽字符串,给定状态
(函数) [编辑]
将宽字符串转换为窄多字节字符字符串
(函数) [编辑]
C++文档关于mbstowcs