WCSRTOMBS - Linux手册页

时间:2019-08-20 18:01:39  来源:igfitidea点击:

Linux程序员手册 第3部分
更新日期: 2019-03-06

名称

wcsrtombs-将宽字符字符串转换为多字节字符串

语法

#include <wchar.h>

size_t wcsrtombs(char *dest, const wchar_t **src,
                 size_t len, mbstate_t *ps);

说明

如果dest不为NULL,则wcsrtombs()函数将宽字符字符串* src转换为以dest开始的多字节字符串。最多len个字节被写入dest。移位状态* ps被更新。只要此调用成功,就可以通过重复调用wcrtomb(dest,* src,ps)来有效地执行转换,然后将dest增加写入的字节数,并将* src增加1。转换可能由于以下三个原因而停止:

1.
遇到了一个宽字符,无法将其表示为多字节序列(根据当前语言环境)。在这种情况下,* src指向无效的宽字符,返回(size_t)-1,并将errno设置为EILSEQ。
2.
长度限制强制停止。在这种情况下,* src指向要转换的下一个宽字符,并返回写入dest的字节数。
3.
宽字符字符串已完全转换,包括终止的空宽字符(Laq \ 0aq),这具有使* ps返回初始状态的副作用。在这种情况下,* src设置为NULL,并且返回写入dest的字节数(不包括终止空字节(aq \ 0aq))。

如果dest为NULL,则len被忽略,并且转换按上述方式进行,只是不将转换后的字节写出到内存中并且不存在长度限制。

在上述两种情况下,如果ps为NULL,则使用仅wcsrtombs()函数已知的静态匿名状态。

程序员必须确保目标处至少有len个字节的空间。

返回值

wcsrtombs()函数返回组成多字节序列的已转换部分的字节数,不包括终止的空字节。如果遇到无法转换的宽字符,则返回(size_t)-1,并将errno设置为EILSEQ。

属性

有关本节中使用的术语的说明,请参见attribute(7)。

InterfaceAttributeValue
wcsrtombs()Thread safetyMT-Unsafe race:wcsrtombs/!ps

遵循规范

POSIX.1-2001,POSIX.1-2008,C99。

备注

wcsrtombs()的行为取决于当前语言环境的LC_CTYPE类别。

作为ps传递NULL不是多线程安全的。

另外参见

iconv(3),mbsinit(3),wcrtomb(3),wcsnrtombs(3),wcstombs(3)

出版信息

这个页面是Linux手册页项目5.08版的一部分。有关项目的说明、有关报告错误的信息以及此页面的最新版本,请访问https://www.kernel.org/doc/man-pages/