wprintf, fwprintf, swprintf, wprintf_s, fwprintf_s, swprintf_s, snwprintf_s

来自cppreference.com
< c‎ | io
 
 
文件输入/输出
类型与对象
函数
文件访问
直接输入/输出
无格式输入/输出
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)
有格式输入
有格式输出
wprintffwprintfswprintfwprintf_sfwprintf_sswprintf_ssnwprintf_s
(C95)(C95)(C95)(C11)(C11)(C11)(C11)
文件寻位
错误处理
文件上的操作
 
在标头 <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),除了在运行时检测下列错误,并调用当前安装的约束处理函数
  • format 中存在转换指定符 %n
  • 任何一个对应 %s 的参数是空指针
  • formatbuffer 是空指针
  • bufsz 为零或大于 RSIZE_MAX/sizeof(wchar_t)
  • 任何一个字符串及字符转换指定符中出现编码错误
  • (仅对于 swprintf_s )将写入的宽字符数(含空宽字符)超出 bufsz
7)(6),但它会截断结果以适于放入 s 所指向的数组。
同所有边界检查函数,wprintf_sfwprintf_sswprintf_ssnwprintf_s,仅若实现定义 __STDC_LIB_EXT1__ 且用户在包含 <stdio.h> 前定义 __STDC_WANT_LIB_EXT1__ 为整数常量 1 才保证可用。

参数

stream - 要写入的输出文件流
buffer - 指向要写入的宽字符串的指针
bufsz - 最多会写入 bufsz - 1 个宽字符,再加空终止符
format - 指向空终止宽字符串的指针,它指定数据转译方式
... - 指定要打印数据的各个实参。若任何实参在默认实参提升后不拥有对应转换指定符所期待的类型,或若实参少于 format 所要求的数量,则行为未定义。若有多于 format 所要求的实参,则求值并忽略额外实参。


格式字符串由普通宽字符(除了 %)和转换指示构成,前者被不改动地复制到输出流。每个转换指示均拥有下列格式:

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

下列格式指示符可用:

转换
指示符
解释 实参类型
长度修饰符→ hh

(C99)

h (无) l ll

(C99)

j

(C99)

z

(C99)

t

(C99)

L
% 写字面的 %。完整的转换指示必须是 %% 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
c
单个字符

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

不适用 不适用
int
wint_t
不适用 不适用 不适用 不适用 不适用
s
字符串

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

不适用 不适用
char*
wchar_t*
不适用 不适用 不适用 不适用 不适用
d
i
转换有符号整数为十进制表示 [-]dddd

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

signed char
short
int
long
long long
有符号的 size_t
不适用
o
转换无符号整数为八进制表示 oooo

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

unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
ptrdiff_t 的无符号版本
不适用
x
X
转换无符号整数为十六进制表示 hhhh

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

不适用
u
转换无符号整数为十进制表示 dddd

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

不适用
f
F
转换浮点数[-]ddd.ddd 样式的十进制记法。

精度指定小数点字符后出现的确切数位数。 默认精度是 6。 在替用实现中即使没有小数点后数位也写小数点。 无穷大和非数的转换样式见注解。

不适用 不适用
double
double (C99)
不适用 不适用 不适用 不适用
long double
e
E
转换浮点数为十进制指数记法。

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

不适用 不适用 不适用 不适用 不适用 不适用
a
A

(C99)

转换浮点数为十六进制指数记法。

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

不适用 不适用 不适用 不适用 不适用 不适用
g
G
转换浮点数为十进制小数或十进制指数记法,依赖于值和精度

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

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

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

不适用 不适用 不适用 不适用 不适用 不适用
n
返回对函数的此调用迄今为止写入的字符数

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

signed char*
short*
int*
long*
long long*
有符号 size_t*
不适用
p 写定义指针的实现定义字符序列。 不适用 不适用 void* 不适用 不适用 不适用 不适用 不适用 不适用

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

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

转换 FEGA 替代上面输出 INFINFINITYNAN

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

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

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

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

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

返回值

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

注意

窄字符串提供 snprintf ,它使得确定需求的缓冲区大小可行,不过(在 snwprintf_s 之前) (C11 起)宽字符串没有其等价物,而为了确定缓冲区大小,程序可能需要调用 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"从 UTF-8 转换: '%s'", narrow_str);
    wprintf(L"%ls\n", warr);
}

输出:

从 UTF-8 转换: 'zß水🍌'

引用

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

参阅

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