Namespaces
Variants

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

From cppreference.net
< c ‎ | io
C
File input/output
Types and objects
Direct input/output
Formatted output
(C99) (C11) (C11) (C11) (C11)
wprintf fwprintf swprintf wprintf_s fwprintf_s swprintf_s snwprintf_s
(C95) (C95) (C95) (C11) (C11) (C11) (C11)
File positioning
Error handling
Operations on files
定义于头文件 <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 的任何参数是空指针
  • format 或 buffer 是空指针
  • bufsz 为零或大于 RSIZE_MAX / sizeof ( wchar_t )
  • 在任何字符串或字符转换说明符中出现编码错误
  • （仅针对 swprintf_s ）待写入的宽字符数量（含空字符）将超过 bufsz
7) 与 (6) 相同，但会截断结果以适应s所指向的数组。
与所有边界检查函数一样，仅当实现定义了 __STDC_LIB_EXT1__ 且用户在包含 <stdio.h> 之前将 __STDC_WANT_LIB_EXT1__ 定义为整型常量 1 时，才保证 wprintf_s 、 fwprintf_s 、 swprintf_s 和 snwprintf_s 可用。

目录

参数

stream - 用于写入的输出文件流
buffer - 指向要写入的宽字符串的指针
bufsz - 最多可写入 bufsz - 1 个宽字符，外加空终止符
format - 指向空终止宽字符串的指针，用于指定数据解析方式
... - 指定要打印数据的参数。若任何参数在 默认参数提升 后不符合对应转换说明符期望的类型，或参数数量少于 format 所需数量，则行为未定义。若参数数量多于 format 所需数量，多余参数会被计算但忽略。


格式 字符串由普通宽字符（除 % 外）和转换说明组成，普通字符将原样复制到输出流。每个转换说明遵循以下格式：

  • 开头的 % 字符。
  • (可选) 一个或多个用于修改转换行为的标志：
  • - ：转换结果在字段内左对齐（默认为右对齐）。
  • + ：有符号转换的符号始终预置于转换结果前（默认仅当结果为负数时前置负号）。
  • space ：若有符号转换结果不以符号字符开头或为空时，将在结果前添加空格。若存在 + 标志则此标志被忽略。
  • # ：执行转换的 替代形式 。具体效果参见下表，否则行为未定义。
  • 0 ：对于整数和浮点数转换，使用前导零而非 空格 字符填充字段。对于整数，若显式指定精度则此标志被忽略。其他转换使用此标志将导致未定义行为。若存在 - 标志则此标志被忽略。
  • (可选) 整数值或 * ，用于指定最小字段宽度。需要时默认使用 空格 字符填充结果：右对齐时在左侧填充，左对齐时在右侧填充。若使用 * ，宽度由类型为 int 的附加参数指定，该参数位于待转换参数之前（若提供了精度参数，则位于精度参数之前）。若参数值为负数，将等效于指定 - 标志并采用正数字段宽度（注意：此宽度为最小值：数值永远不会被截断）。
  • (可选) . 后接整数或 * ，或两者皆无，用于指定转换的 精度 。当使用 * 时， 精度 由类型为 int 的附加参数指定，该参数出现在待转换参数之前，但在提供最小字段宽度的参数（若存在）之后。若此参数值为负数，则被忽略。若未使用数字或 * ，则精度视为零。具体 精度 的影响请参阅下表。
  • (可选) 长度修饰符 ，用于指定参数的大小（与转换格式说明符结合使用时，可指定对应参数的类型）。
  • 转换格式说明符。

以下格式说明符可用：

转换
说明符 		说明 期望
参数类型
长度修饰符→ hh h 无 l ll j z t L
仅自 C99 起可用→ 是 是 是 是 是
% 写入字面量 % 。完整转换说明必须为 %% 。 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
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 ​ ，则转换结果无字符。
  • 对于 z 修饰符，期望参数类型为 size_t 的有符号版本。
signed char
short
int
long
long long
※
不适用
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 ​ ，则转换结果无字符。
  • 在 替代实现 中，若转换值非零，则结果前缀 0x 或 0X 。
不适用
u

将 无符号整数 转换为十进制表示 dddd 。

  • 精度 指定要出现的最小位数。
  • 默认精度为 1 。
  • 若转换值和精度均为 ​ 0 ​ ，则转换结果无字符。
不适用
f
F (C99)

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

  • 精度 指定小数点后要出现的精确位数。
  • 默认精度为 6 。 </

返回值

1,2) 若成功则返回写入的宽字符数量，若出现错误则返回负值。
3) 成功时写入的宽字符数量（不包含终止空宽字符），若发生编码错误或待生成的字符数量大于等于 bufsz （包括当 bufsz 为零时）则返回负值。
4,5) 若成功则返回写入的宽字符数量，若出现错误则返回负值。
6) 写入到 buffer 的宽字符数量（不包含终止空字符）。编码错误和缓冲区溢出时返回负值。其他所有错误情况下返回零。
7) 本应写入 buffer 的宽字符数量（不包含终止空字符），前提是 bufsz 足够大；若发生错误则返回负值。（即：仅当返回值非负且小于 bufsz 时，写入操作才成功完成）

注释

虽然窄字符串提供了 snprintf ，使得确定所需输出缓冲区大小成为可能，但宽字符串没有等效函数 （直至 snwprintf_s 出现） (C11起) 。为了确定缓冲区大小，程序可能需要调用 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ß水🍌'

参考文献

  • C23 标准 (ISO/IEC 9899:2024):
  • 7.29.2.1 fwprintf 函数 (p: TBD)
  • 7.29.2.3 swprintf 函数 (p: TBD)
  • 7.29.2.11 wprintf 函数 (p: TBD)
  • K.3.9.1.1 fwprintf_s 函数 (p: TBD)
  • K.3.9.1.4 swprintf_s 函数 (p: TBD)
  • K.3.9.1.13 wprintf_s 函数 (p: TBD)
  • C17 标准 (ISO/IEC 9899:2018):
  • 7.29.2.1 fwprintf 函数 (p: TBD)
  • 7.29.2.3 swprintf 函数 (p: TBD)
  • 7.29.2.11 wprintf 函数 (p: TBD)
  • K.3.9.1.1 fwprintf_s 函数 (p: TBD)
  • K.3.9.1.4 swprintf_s 函数 (p: TBD)
  • K.3.9.1.13 wprintf_s 函数 (p: TBD)
  • C11 标准 (ISO/IEC 9899:2011):
  • 7.29.2.1 fwprintf 函数 (p: 403-410)
  • 7.29.2.3 swprintf 函数 (p: 416)
  • 7.29.2.11 wprintf 函数 (p: 421)
  • K.3.9.1.1 fwprintf_s 函数 (p: 628)
  • K.3.9.1.4 swprintf_s 函数 (p: 630-631)
  • K.3.9.1.13 wprintf_s 函数 (p: 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