int sprintf_s(
char *buffer,
size_t sizeOfBuffer,
const char *format,
int _sprintf_s_l(
char *buffer,
size_t sizeOfBuffer,
const char *format,
_locale_t locale,
int swprintf_s(
wchar_t *buffer,
size_t sizeOfBuffer,
const wchar_t *format,
int _swprintf_s_l(
wchar_t *buffer,
size_t sizeOfBuffer,
const wchar_t *format,
_locale_t locale,
template <size_t size>
int sprintf_s(
char (&buffer)[size],
const char *format,
); // C++ only
template <size_t size>
int swprintf_s(
wchar_t (&buffer)[size],
const wchar_t *format,
); // C++ only
buffer
输出的存储位置
sizeOfBuffer
可存储的最多字符数。
format
格式控件字符串
要设置格式的可选参数
locale
要使用的区域设置。
有关详细信息,请参阅格式规范语法。
写入的字符数或 -1(如果发生错误)。 如果 buffer
或 format
是 null 指针,sprintf_s
和 swprintf_s
将返回 -1 并将 errno
设置为 EINVAL
。
sprintf_s
返回存储在 buffer
中的字节数,不包括终止 null 字符。 swprintf_s
返回存储在 buffer
中的宽字符数,不包括中止 null 宽字符。
sprintf_s
函数存储 buffer
中的一系列字符和值并设置格式。 每个 argument
(如果有)根据 format
中相应的格式规范进行转换和输出。 该格式包括普通字符,其形式和函数与 format
的 printf
参数相同。 null 字符追加在写入的最后一个字符后。 如果在重叠的字符串之间发生复制,则此行为不确定。
sprintf_s
和 sprintf
之间的一个主要区别是, sprintf_s
检查格式字符串中的有效格式设置字符,而 sprintf
仅检查格式字符串或缓冲区是否为 NULL
指针。 如果任一检查失败,将调用无效参数处理程序,如 Parameter Validation中所述。 如果允许执行继续,则该函数将返回 -1 并将 errno
设置为 EINVAL
。
sprintf_s
和 sprintf
之间的另一主要区别是, sprintf_s
使用长度参数来指定字符中输出缓冲区的大小。 如果缓冲区对于格式化文本(包括终止 null)来说太小,则将通过在 buffer[0]
处放置 null 字符而将缓冲区设置为空字符串,并调用无效的参数处理程序。 与 _snprintf
不同, sprintf_s
可保证缓冲区以 null 终止(除非缓冲区大小为零)。
swprintf_s
是 sprintf_s
的宽字符版本; swprintf_s
的指针参数是宽字符串。 swprintf_s
中的编码错误检测可能与 sprintf_s
中的检测不同。 这些带有 _l
后缀的函数的版本相同,只不过它们使用传递的区域设置参数而不是当前线程区域设置。
在 C++ 中,通过模板重载可简化这些函数的使用。 重载可自动推导出缓冲区的长度,不再需要指定 size 参数。 而且,它们可以自动将不安全的旧函数替换为更新、更安全的函数。 有关详细信息,请参阅安全模板重载。
sprintf_s
的一些版本可在缓冲区过小时对所发生的情况进行更多控制。 有关详细信息,请参阅 _snprintf_s
、_snprintf_s_l
、_snwprintf_s
、_snwprintf_s_l
。
从 Windows 10 版本 2004(内部版本 19041)开始,printf
系列函数根据 IEEE 754 的舍入规则输出可精确表示的浮点数。 在早期的 Windows 版本中,以“5”结尾并且可精确表示的浮点数总是向上取整。 IEEE 754 规定它们必须舍入到最接近的偶数(也称为“四舍六入五成双”)。 例如,printf("%1.0f", 1.5)
和 printf("%1.0f", 2.5)
都应舍入为 2。 之前,1.5 舍入为 2,2.5 舍入为 3。 此更改仅影响可精确表示的数字。 例如,2.35(用于内存表示时更接近于 2.35000000000000008)仍然向上取整为 2.4。 这些函数完成的舍入现在也遵循 fesetround
设置的浮点舍入模式。 以前,舍入始终选择 FE_TONEAREST
行为。 此更改仅影响使用 Visual Studio 2019 版本 16.2 及更高版本生成的程序。 若要使用旧的浮点舍入行为,请链接到 'legacy_stdio_float_rounding.obj`。
一般文本例程映射
TCHAR.H 例程
_UNICODE
和 _MBCS
未定义
_MBCS
已定义
_UNICODE
已定义
// crt_sprintf_s.c
// This program uses sprintf_s to format various
// data and place them in the string named buffer.
#include <stdio.h>
int main( void )
char buffer[200], s[] = "computer", c = 'l';
int i = 35, j;
float fp = 1.7320534f;
// Format and print various data:
j = sprintf_s( buffer, 200, " String: %s\n", s );
j += sprintf_s( buffer + j, 200 - j, " Character: %c\n", c );
j += sprintf_s( buffer + j, 200 - j, " Integer: %d\n", i );
j += sprintf_s( buffer + j, 200 - j, " Real: %f\n", fp );
printf_s( "Output:\n%s\ncharacter count = %d\n", buffer, j );
Output:
String: computer
Character: l
Integer: 35
Real: 1.732053
character count = 79
示例:错误代码处理
// crt_swprintf_s.c
// wide character example
// also demonstrates swprintf_s returning error code
#include <stdio.h>
int main( void )
wchar_t buf[100];
int len = swprintf_s( buf, 100, L"%s", L"Hello world" );
printf( "wrote %d characters\n", len );
len = swprintf_s( buf, 100, L"%s", L"Hello\xffff world" );
// swprintf_s fails because string contains WEOF (\xffff)
printf( "wrote %d characters\n", len );
wrote 11 characters
wrote -1 characters
流 I/O