命名空间
变体
操作

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

来自 cppreference.cn
< c‎ | io
 
C
 
文件输入/输出
类型和对象
        
函数
文件访问
(C11)
(C11)  
(C95)
无格式输入/输出
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)
(C95)
(C95)

格式化输入
(C99)(C99)(C99)(C11)(C11)(C11)
(C99)(C99)(C99)(C11)(C11)(C11)  
直接输入/输出
格式化输出
(C99)(C11)(C11)(C11)(C11)
wprintffwprintfswprintfwprintf_sfwprintf_sswprintf_ssnwprintf_s
(C95)(C95)(C95)(C11)(C11)(C11)(C11)  
文件定位
错误处理
文件操作
 
定义于头文件 <wchar.h>
(1)
int wprintf( const wchar_t* format, ... );
 (since C95)
(until C99)
int wprintf( const wchar_t* restrict format, ... );
 (since C99)
(2)
int fwprintf( FILE* stream, const wchar_t* format, ... );
 (since C95)
(until C99)
int fwprintf( FILE* restrict stream,
              const wchar_t* restrict format, ... );
 (since C99)
(3)
int swprintf( wchar_t* buffer, size_t bufsz,
              const wchar_t* format, ... );
 (since C95)
(until C99)
int swprintf( wchar_t* restrict buffer, size_t bufsz,
              const wchar_t* restrict format, ... );
 (since C99)
int wprintf_s( const wchar_t* restrict format, ... );
 (4) (since C11)
int fwprintf_s( FILE* restrict stream,
                const wchar_t* restrict format, ... );
 (5) (since C11)
int swprintf_s( wchar_t* restrict buffer, rsize_t bufsz,
                const wchar_t* restrict format, ... );
 (6) (since C11)
int snwprintf_s( wchar_t* restrict s, rsize_t n,
                 const wchar_t* restrict format, ... );
 (7) (since C11)

从给定位置加载数据，将其转换为宽字符串等效形式，并将结果写入各种接收器。

1) 将结果写入 stdout。
2) 将结果写入文件流 stream。
3) 如果 bufsz 大于零，则将结果写入宽字符串 buffer。最多写入 bufsz - 1 个宽字符，后跟空宽字符。如果 bufsz 为零，则不写入任何内容（并且 buffer 可以为空指针）。
4-6) 与 (1-3) 相同，但以下错误在运行时检测到，并调用当前安装的 constraint handler 函数
  • 转换说明符 %n 出现在 format 中
  • 对应于 %s 的任何参数都是空指针
  • format 或 buffer 是空指针
  • bufsz 为零或大于 RSIZE_MAX / sizeof(wchar_t)
  • 编码错误发生在任何字符串和字符转换说明符中
  • (仅对于 swprintf_s) 要写入的宽字符数（包括 null）将超过 bufsz。
7) 与 (6) 相同，但它将截断结果以适应 s 指向的数组。
与所有边界检查函数一样，仅当实现定义了 __STDC_LIB_EXT1__ 并且用户在包含 之前将 __STDC_WANT_LIB_EXT1__ 定义为整数常量 1 时，才能保证 wprintf_s、fwprintf_s、swprintf_s 和 snwprintf_s 可用。

目录

[编辑] 参数

stream - 要写入的输出文件流
buffer - 指向要写入的宽字符串的指针
bufsz - 最多可以写入 bufsz - 1 个宽字符，加上空终止符
format - 指向空终止的宽字符串的指针，指定如何解释数据
... - 指定要打印的数据的参数。 如果在默认参数提升之后的任何参数不是相应转换说明符期望的类型，或者如果参数少于 format 要求的参数，则行为未定义。 如果参数多于 format 要求的参数，则会对多余的参数进行评估并忽略。


format 字符串由普通宽字符（除了 %）组成，它们被不变地复制到输出流中，以及转换说明符。 每个转换说明符具有以下格式

  • 引导 % 字符。
  • (可选) 一个或多个标志，用于修改转换的行为
  • -：转换结果在字段内左对齐（默认情况下为右对齐）。
  • +：带符号转换的符号始终添加到转换结果的前面（默认情况下，结果仅在为负数时才以减号开头）。
  • 空格：如果带符号转换的结果不以符号字符开头，或者为空，则空格会添加到结果的前面。 如果存在 + 标志，则忽略它。
  • #：执行转换的替代形式。 有关确切效果，请参见下表，否则行为未定义。
  • 0：对于整数和浮点数转换，前导零用于填充字段，而不是空格字符。 对于整数，如果显式指定了精度，则忽略它。 对于使用此标志的其他转换，会导致未定义的行为。 如果存在 - 标志，则忽略它。
  • (可选) 整数值或 *，用于指定最小字段宽度。 如果需要，结果将用空格字符（默认情况下）填充，在右对齐时在左侧填充，或者在左对齐时在右侧填充。 如果使用 *，则宽度由 int 类型的附加参数指定，该参数出现在要转换的参数和提供精度的参数（如果提供）之前。 如果参数的值为负数，则结果为指定的 - 标志和正字段宽度（注意：这是最小宽度：该值永远不会被截断。）。
  • (可选) . 后跟整数或 *，或者两者都不指定转换的精度。 如果使用 *，则精度由 int 类型的附加参数指定，该参数出现在要转换的参数之前，但在提供最小字段宽度的参数（如果提供）之后。 如果此参数的值为负数，则忽略它。 如果既不使用数字也不使用 *，则精度取为零。 有关精度的确切效果，请参见下表。
  • (可选) 长度修饰符，用于指定参数的大小（与转换格式说明符结合使用，它指定相应参数的类型）。
  • 转换格式说明符。

以下格式说明符可用

转换
说明符		 说明 预期
参数类型
长度修饰符→ hh h 无 l ll j z t L
仅自 C99 起可用→ 是 是 是 是 是
% 写入字面量 %。 完整的转换说明符必须是 %%。 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​，则转换不会产生任何字符。
  • 对于 z 修饰符，预期的参数类型是 size_t 的带符号版本。
signed char
short
int
long
long long
※
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 (C99)

将浮点数转换为十进制表示法，样式为 [-]ddd.ddd。

  • 精度指定小数点字符后要出现的精确位数。
  • 默认精度为 6。
  • 在替代实现中，即使小数点后没有数字，也会写入小数点字符。
  • 有关无穷大和非数字转换样式，请参见注释。
 N/A N/A
double
double (C99)
 N/A N/A N/A N/A
long double
e
E

将浮点数转换为十进制指数表示法。

  • 对于 e 转换样式，使用 [-]d.ddd e±dd。
  • 对于 E 转换样式，使用 [-]d.ddd E±dd。
  • 指数至少包含两位数字，仅在必要时才使用更多数字。
  • 如果值为 ​0​，则指数也为 ​0​。
  • 精度指定小数点字符后要出现的精确位数。
  • 默认精度为 6。
  • 在替代实现中，即使小数点后没有数字，也会写入小数点字符。
  • 有关无穷大和非数字转换样式，请参见注释。
 N/A N/A N/A N/A N/A N/A
a
A

(C99)

将浮点数转换为十六进制指数表示法。

  • 对于 a 转换样式，使用 [-] 0xh.hhh p±d。
  • 对于 A 转换样式，使用 [-] 0Xh.hhh P±d。
  • 如果参数是规范化的浮点值，则第一个十六进制数字不是 0。
  • 如果值为 ​0​，则指数也为 ​0​。
  • 精度指定十六进制小数点字符后要出现的精确位数。
  • 默认精度足以精确表示该值。
  • 在替代实现中，即使小数点后没有数字，也会写入小数点字符。
  • 有关无穷大和非数字转换样式，请参见注释。
 N/A N/A N/A N/A N/A N/A
g
G

根据值和精度将浮点数转换为十进制或十进制指数表示法。

  • 对于 g 转换样式，将执行样式为 e 或 f 的转换。
  • 对于 G 转换样式，将执行样式为 E 或 f(until C99)F(since C99) 的转换。
  • 令 P 等于精度（如果非零），如果未指定精度则为 6，如果精度为 ​0​ 则为 1。 然后，如果样式为 E 的转换将具有指数 X
    • 如果 P > X ≥ −4，则转换样式为 f 或 F(since C99)，精度为 P − 1 − X。
    • 否则，转换样式为 e 或 E，精度为 P − 1。
  • 除非请求替代表示形式，否则将删除尾随零，如果未留下小数部分，则还将删除小数点字符。
  • 有关无穷大和非数字转换样式，请参见注释。
 N/A N/A N/A N/A N/A N/A
n

返回此函数调用到目前为止写入的字符数。

  • 结果写入到参数指向的值。
  • 规范不能包含任何标志、字段宽度或精度。
  • 对于 z 修饰符，预期的参数类型为 S*，其中 S 是 size_t 的带符号版本。
signed char*
short*
int*
long*
long long*
※
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 代替。

用于打印 char、unsigned char、signed char、short 和 unsigned short 的转换说明符期望默认参数提升的提升类型，但在打印之前，其值将转换为 char、unsigned char、signed char、short 和 unsigned short。 传递这些类型的值是安全的，因为在调用可变参数函数时会发生提升。

固定宽度字符类型（int8_t 等）的正确转换规范在头文件 <inttypes.h> 中定义（尽管 PRIdMAX、PRIuMAX 等与 %jd、%ju 等同义）。

内存写入转换说明符 %n 是安全漏洞的常见目标，其中格式字符串取决于用户输入，并且边界检查的 printf_s 函数系列不支持它(since C11)。

在每个转换说明符的操作之后都有一个序列点； 这允许在同一变量中存储多个 %n 结果，或者作为边缘情况，在同一次调用中打印由较早的 %n 修改的字符串。

如果转换规范无效，则行为未定义。

[编辑] 返回值

1,2) 如果成功，则写入的宽字符数；如果发生错误，则为负值。
3) 如果成功，则写入的宽字符数（不包括终止空宽字符）；如果发生编码错误，或者要生成的字符数等于或大于 bufsz（包括 bufsz 为零时），则为负值。
4,5) 如果成功，则写入的宽字符数；如果发生错误，则为负值。
6) 写入 buffer 的宽字符数（不包括终止空字符）。 编码错误和溢出时返回负值。 在所有其他错误时返回零。
7) 如果 bufsz 足够大，则将写入 buffer 的宽字符数（不包括终止空字符），或者如果发生错误，则为负值。 （意思是，只有当返回值非负数且小于 bufsz 时，写入才成功且完整）

[编辑] 注释

虽然窄字符串提供了 snprintf，这使得可以确定所需的输出缓冲区大小，但宽字符串没有等效项（直到 snwprintf_s），并且为了确定缓冲区大小，程序可能需要调用 swprintf，检查结果值，并重新分配更大的缓冲区，再次尝试直到成功。

snwprintf_s 与 swprintf_s 不同，即使截断被大多数边界检查函数视为错误，它也会截断结果以适应 buffer 指向的数组。

[编辑] 示例

运行此代码
#include <locale.h>
#include <wchar.h>
 
int main(void)
{
    char narrow_str[] = "z\u00df\u6c34\U0001f34c";
                  // or "zß水🍌"
                  // or "\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9f\x8d\x8c";
    wchar_t warr[29]; // the expected string is 28 characters plus 1 null terminator
    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ß水🍌'

[编辑] 参考

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

[编辑] 参见

(C99)(C11)(C11)(C11)(C11)
 将格式化输出打印到 stdout、文件流或缓冲区
(函数) [编辑]
(C95)(C95)(C95)(C11)(C11)(C11)(C11)
 将格式化的宽字符输出打印到 stdout、文件流
或使用可变参数列表的缓冲区
(函数) [编辑]
(C95)
 将宽字符串写入文件流
(函数) [编辑]
C++ 关于 wprintf, fwprintf, swprintf 的文档
取自 "https://cppreference.cn/mwiki/index.php?title=c/io/fwprintf&oldid=172124"