wprintf, fwprintf, swprintf, wprintf_s, fwprintf_s, swprintf_s

来自cppreference.com
< c‎ | io
定义于头文件 <wchar.h>
(1)
int wprintf( const wchar_t *format, ... );
(C95 起)
(C99 前)
int wprintf( const wchar_t *restrict format, ... );
(C99 起)
(2)
int fwprintf( FILE *stream, const wchar_t* format, ... );
(C95 起)
(C99 前)
int fwprintf( FILE *restrict stream,
              const wchar_t *restrict format, ... );
(C99 起)
(3)
int swprintf( wchar_t *buffer, size_t bufsz,
              const wchar_t* format, ... );
(C95 起)
(C99 前)
int swprintf( wchar_t *restrict buffer, size_t bufsz,
              const wchar_t *restrict format, ... );
(C99 起)
int wprintf_s( const wchar_t *restrict format, ...);
(4) (C11 起)
int fwprintf_s( FILE *restrict stream,
                const wchar_t *restrict format, ...);
(5) (C11 起)
int swprintf_s( wchar_t *restrict buffer, rsize_t bufsz,
                const wchar_t* restrict format, ...);
(6) (C11 起)
int snwprintf_s( wchar_t * restrict s, rsize_t n,
                 const wchar_t * restrict format, ...);
(7) (C11 起)

从给定位置加载数据,将它们转换成宽字符串等价物并将结果写入各种池中。

1) 写结果到stdout
2) 写结果到文件流stream
3)bufsz大于零,则写结果到宽字符串buffer。至多允许写入后随空宽字符的bufsz-1个宽字符。若bufsz为零,则不写入任何内容(且buffer可以是空指针)然而返回值(会被写入的宽字符数)被照样计算并返回。
4-6)(1-3),除了在运行时检测下列错误并调用当前安装的强制处理函数:
  • 转换指定符%n存在于format
  • 任何一个对应%s的参数是空指针
  • formatbuffer是空指针
  • bufsz为零或大于RSIZE_MAX
  • 在任何一个字符串及字符转换指定符中出现编码错误
  • (仅对于swprintf_s)会被写入的宽字符数,含空宽字符,将要超出bufsz
7)(6),除了它将截断结果以适应buffer所指向的数组。
同所有边界检查函数,仅若实现定义了__STDC_LIB_EXT1__且用户在包含<wchar.h>前定义__STDC_WANT_LIB_EXT1__为整数常量1,才保证wprintf_sfwprintf_sswprintf_ssnwprintf_s可用。

目录

[编辑] 参数

stream - 要写入的输出文件流
buffer - 指向要写入的宽字符串的指针
bufsz - 最多会写入bufsz - 1个宽字符,再加空终止符
format - 指向指定数据转译方式的空终止宽字符串的指针。

格式字符串由会被无更改地复制到输出流的普通宽字符(除了%),和转换指定构成。每个转换指定拥有下列格式:

  • 引入的%字符
  • (可选)一或多个修改转换行为的标签:
  • -:转换结果在域内左校正(默认是右校正的)
  • +:有符号转换的符号始终前置于转换结果(默认结果前置负号仅当它为负)
  • 空格:若有符号转换的结果不以符号开始,或为空,则前置空格于结果。若存在+标签则忽略空格
  • #:进行另一种形式的转换。准确的效果见下表,其他情况下行为未定义。
  • 0:对于整数和浮点数转换,使用前导零代替空格字符填充域。对于整数,若显式指定精度,则忽略此标签。对于其他转换,使用此标签导致未定义行为。若存在-标签则忽略0
  • (可选)指定最小域宽的整数值或*。若有要求,则结果会以空格字符(默认情况)填充,在右校正时于左,左校正时于右。在使用*的情况下,宽度会以一个额外的int类型参数指定。若参数值为负数,则它导致指定-标签和正域宽。(注意:这是最小宽度:值决不会被截断)。
  • (可选)后随整数或*或两者皆无的.指示转换的精度。在使用*的情况下,精度由额外的int类型参数指定。若此参数的值为负数,则它被忽略。若既不使用数字亦不使用*,则精度采用零。精度的准确效果见下表。
  • (可选)指定参数大小的长度修饰符
  • 转换格式指定符

下列格式指定符可用:

转换
指定符
解释 参数类型
长度修饰符 hh

(C99)

h (无) l ll

(C99)

j

(C99)

z

(C99)

t

(C99)

L
% 写字面的%。完整转换限定必须是%% N/A N/A N/A N/A N/A N/A N/A N/A N/A
c
单个字符

参数首先被转换成wchar_t,如同通过调用btowc。 若使用l修饰符,则wint_t参数首先被转换成wchar_t

N/A N/A
int
wint_t
N/A N/A N/A N/A N/A
s
写一个字符串

参数必须为一个指针,指向包含以初始迁移状态开始的,多字节字符序列的字符数组首元素,数组会被转换成宽字符数组,如同通过以零初始化转换状态调用mbrtowc精度指定写入的最大宽字符数。若未指定精度,则写每个宽字符直到而不含首个空终止符。 若使用l指定符,则参数必须是指向wchar_t数组首元素的指针。

N/A N/A
char*
wchar_t*
N/A N/A N/A N/A N/A
d
i
转换一个有符号整数到十进制表示[-]dddd

精度指定出现的最小数位数。默认精度是1
若被转换的值和精度都是0,则转换结果无字符。

signed char
short
int
long
long long
有符号size_t
N/A
o
转换一个无符号整数到八进制表示oooo

精度指定出现的最小数位数。默认精度是1。 若被转换值和精度都是0,则转换结果无字符。 在另一种实现中精度按需增加,以写入一个前导零。 在此情况下若被转换值和精度都是0,则写入单个0

unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
ptrdiff_t的无符号版本
N/A
x
X
转换一个无符号整数到十六进制表示hhhh

x转换使用字母abcdef
X转换使用ABCDEF
精度指定出现的最小数位数。默认精度是1。 若被转换值和精度都是0,则转换结果无字符。 在另一种实现中若被转换值为非零则结果有0x0X前缀。

N/A
u
转换一个无符号整数为十进制表示dddd

精度指定出现的最小数位数。 默认精度是1。 若被转换值和精度都是0,则转换结果无字符。

N/A
f
F
转换一个浮点数[-]ddd.ddd样式的十进制记法。

精度指定小数点字符后出现的最小数位数。 默认精度是6。 在另一种实现中即使没有小数点后数位也写小数点。 无穷大和非数的转换样式见注意。

N/A N/A
double
double (C99)
N/A N/A N/A N/A
long double
e
E
转换一个浮点数为十进制指数记法。

e转换样式使用[-]d.ddde±dd
E转换样式使用[-]d.dddE±dd
指数至少含二个数位,仅当所需时使用更多数位。 若值为0,则指数亦为0精度指定小数点字符后出现的最小数位数。 默认精度是6。 在另一种实现中即使没有小数点后数位也写小数点。 无穷大和非数的转换样式见注意。

N/A N/A N/A N/A N/A N/A
a
A

(C99)

转换一个浮点数为十六进制记号。

a转换样式使用[-]0xh.hhhp±d
A转换样式使用[-]0Xh.hhhP±d
若参数不是正规化的浮点值,则首个十六进制数位为0。 若值为0,则指数亦为0精度指定小数点字符后出现的最小数位数。 默认精度足以准确表示该值。 在另一种实现中即使没有小数点后数位也写小数点。 无穷大和非数的转换样式见注意。

N/A N/A N/A N/A N/A N/A
g
G
转换一个浮点数为十进制小数或十进制指数记法,依赖于值和精度

g转换样式将进行带样式ef的转换。
G转换样式将进行带样式EF的转换。
P等于精度,若精度非零,若精度未指定则为6,若精度为0则等于1。然后,若带样式E的转换会有指数X,则:

  • P > X ≥ −4,则转换带fF风格,及精度P − 1 − X
  • 否则,转换带eE风格,及精度P − 1

除非要求另一种表示,否则末尾零会被移除,且若不留下小数部分则小数点亦被移除。 无穷大和非数的转换样式见注意。

N/A N/A N/A N/A N/A N/A
n
返回对函数的此调用迄今为止写入的字符数

结果被写入到参数所指向的值。 该指定不可含有任何标签域宽精度

signed char*
short*
int*
long*
long long*
signed size_t*
N/A
p 写定义一个指针的实现定义字符序列。 N/A N/A void* N/A N/A N/A N/A N/A N/A

浮点转换函数转换无穷大到infinfinity。使用哪一个是实现定义的。

非数转换成nannan(char_sequence)。使用哪一个是实现定义的。

转换FEGA替代上面输出INFINFINITYNAN

尽管%c期待int参数,传递char是安全的,因为在调用变参数函数时发生整数提升。

定宽整数类型(int8_t等)的正确转换指定定义于头文件<inttypes.h>(尽管PRIdMAXPRIuMAX等就是%jd%ju等的别名)。

内存写入转换指定符%n是安全漏洞的常见目标,这里格式字符串依赖用户输入,而此转换指定符不为边界检查的printf_s系列函数所支持。

在每个转换限定符的行动后有一个序列点;这允许存入多次%n的结果于同一变量,并在同一调用中打印出先前以%n存储的值。

若转换限定非法,则行为未定义。


... - 指定要打印数据的参数

[编辑] 返回值

1,2) 若成功则为写入的宽字符数,若错误发生则为负值。
3) 若成功则为写入的宽字符数(不计空终止宽字符),若编码错误发生或被生成的宽字符数等于或大于size(含size为零时)则为负值。
4,5) 若成功则为写入的宽字符数,若错误发生则为负值。
6) 写入buffer的宽字符数(不计空终止符)。编码错误发生和溢出时返回负值。所有其他错误发生时返回零。
7) 假如bufsz充分大则本应写入buffer的宽字符数(不计空终止符),或者若错误发生则为负值。(即写入成功仅当返回值非负且小于bufsz)。

[编辑] 注意

窄字符串提供snprintf,它使得确定需求的缓冲区大小可行,不过宽字符串没有等价物(在C11的snwprintf_s前),而为了确定缓冲区大小,程序可能需要调用swprintf,检查返回值,并重分配更大的缓冲区,反复尝试直至成功。

不同于swprintf_ssnwprintf_s将截断结果以适应buffer所指向的数组,尽管这种截断被多数边界检查函数当做错误。

[编辑] 示例

#include <locale.h>
#include <wchar.h>
 
int main(void)
{
    char narrow_str[] = "z\u00df\u6c34\U0001f34c";
                    // 或"zß水🍌"
                    // 或"\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9f\x8d\x8c";
    wchar_t warr[29]; // 期待的字符串为28字节加1个空终止符
    setlocale(LC_ALL, "en_US.utf8");
    swprintf(warr, sizeof warr/sizeof *warr,
              L"Converted from UTF-8: '%s'", narrow_str);
    wprintf(L"%ls\n", warr);
}

输出:

Converted from UTF-8: 'zß水🍌'

[编辑] 参考

  • C11 standard (ISO/IEC 9899:2011):
  • 7.29.2.1 The fwprintf function (p: 403-410)
  • 7.29.2.3 The swprintf function (p: 416)
  • 7.29.2.11 The wprintf function (p: 421)
  • K.3.9.1.1 The fwprintf_s function (p: 628)
  • K.3.9.1.4 The swprintf_s function (p: 630-631)
  • K.3.9.1.13 The wprintf_s function (p: 637-638)
  • C99 standard (ISO/IEC 9899:1999):
  • 7.24.2.1 The fwprintf function (p: 349-356)
  • 7.24.2.3 The swprintf function (p: 362)
  • 7.24.2.11 The wprintf function (p: 366)

[编辑] 参阅

打印格式化输出到stdout、文件流或缓冲区
(函数) [edit]
打印格式化宽字符输出到stdout、文件流或缓冲区
使用可变参数列表
(函数) [edit]
(C95)
将一个宽字符串写入文件流
(函数) [edit]
wprintf, fwprintf, swprintfC++文档