C 参考手册

位置：首页 > C 参考手册 >文件输入/输出 > wprintf, fwprintf, swprintf, wprintf_s, fwprintf_s, swprintf_s, snwprintf_s

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

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

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

参数

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​ ，则转换结果无字符。 在替用实现中若被转换值为非零则结果有 0x 或 0X 前缀。

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 转换样式将进行带样式 e 或 f 的转换。
G 转换样式将进行带样式 E 或 F 的转换。
令 P 等于精度，若它非零，若精度未指定则为 6 ，若精度为 ​0​ 则等于 1 。然后，若带样式 E 的转换会有指数 X ，则：

  • è‹¥ P > X ≥ −4 ，则转换带 f 或 F 风格，及精度 P − 1 − X 。
  • 否则，转换带 e 或 E 风格，及精度 P − 1 。

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

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

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

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

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

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

转换 F 、 E 、 G 、 A 替代上面输出 INF 、 INFINITY 、 NAN。

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

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

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

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

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


... - 指定要打印数据的参数。若任何参数在默认参数提升后不拥有对应转换指定符所期待的类型，或若参数少于 format 所要求的数量，则行为未定义。若有多于 format 所要求的参数，则求值并忽略额外参数

返回值

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

注意

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

不同于 swprintf_s ， snwprintf_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)

参阅

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