_snprintf_s, _snprintf_s_l, _snwprintf_s, _snwprintf_s_l

将格式化的数据写入字符串。 这些函数的版本是 snprintf_snprintf_snprintf_l_snwprintf_snwprintf_l,具有安全性增强功能,如 CRT 中的安全功能中所述。

语法

int _snprintf_s(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format [,
   argument] ...
);

int _snprintf_s_l(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format,
   _locale_t locale [,
   argument] ...
);

int _snwprintf_s(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format [,
   argument] ...
);

int _snwprintf_s_l(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format,
   _locale_t locale [,
   argument] ...
);

template <size_t size>
int _snprintf_s(
   char (&buffer)[size],
   size_t count,
   const char *format [,
   argument] ...
); // C++ only

template <size_t size>
int _snwprintf_s(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format [,
   argument] ...
); // C++ only

参数

buffer
输出的存储位置。

sizeOfBuffer
输出的存储位置大小。 对于采用 char 的函数,大小以字节为单位,对于采用 wchar_t 的函数,以字为单位

count
要写入的最大字符数。 对于采用 wchar_t 的函数,要写入的最大宽字符数。 或 _TRUNCATE

format
窗体控件字符串。

argument
可选参数。

locale
要使用的区域设置。

返回值

写入的字符数,不包括终止 NULL。 如果输出发生错误,则返回负值。 有关详细信息,请参阅行为摘要

备注

_snprintf_s 函数格式化并将 count 或更少字符存储在 buffer 中,并追加终止 NULL。 每个参数(如果有)根据 format 中相应的格式规范进行转换和输出。 格式设置与 printf 系列函数一致,请参阅格式规范语法:printfwprintf 函数。 如果在重叠的字符串之间发生复制,则此行为不确定。

行为摘要

对于下表:

len 设置为格式化数据的大小。 如果函数采用 char 缓冲区,则大小以字节为单位。 如果函数采用 wchar_t 缓冲区,则大小指定 16 位字的数目。

  • 字符是指采用 char 缓冲区的函数的 char 字符,以及采用 wchar_t 缓冲区的函数 wchar_t 字符。
  • 有关无效参数处理程序的详细信息,请参阅参数验证
条件 行为 返回值 errno 调用无效参数处理程序
Success 使用指定的格式字符串将字符写入缓冲区。 写入的字符数,不包括终止 NULL 不可用
格式设置过程中的编码错误 如果处理字符串说明符 sSZ,格式规范处理将停止。 -1 EILSEQ (42)
格式设置过程中的编码错误 如果处理字符说明符 cC,则会跳过无效字符。 为跳过的字符写入的字符数不会递增,也不会为它写入任何数据。 跳过说明符并出现编码错误后,继续处理格式规范。 写入的字符数,不包括终止 NULL EILSEQ (42)
buffer == NULLsizeOfBuffer == 0count == 0 未写入任何数据。 0 不可用
buffer == NULL 以及 sizeOfBuffer != 0count != 0 如果执行无效的参数处理程序后继续执行,则设置 errno 并返回负值。 -1 EINVAL (22)
buffer != NULLsizeOfBuffer == 0 未写入任何数据。 -1 EINVAL (22)
count == 0 NULL 放在缓冲区的开头。 -1 不可用
count < 0 不安全:该值被视为无符号值,可能会创建一个大值,导致覆盖缓冲区后面的内存。 写入的字符数,不包括终止 NULL 不可用
count < sizeOfBufferlen <= count 将写入所有数据,并追加终止 NULL 写入的字符数。 不可用
count < sizeOfBufferlen > count 将写入第一个 count 字符,并追加终止 NULL -1 不可用
count >= sizeOfBufferlen < sizeOfBuffer 所有数据都以终止 NULL 写入。 写入的字符数。 不可用
count >= sizeOfBufferlen >= sizeOfBuffercount != _TRUNCATE 如果执行无效的参数处理程序后继续执行,则设置 errno、设置 buffer[0] == NULL 并返回负值。 -1 ERANGE (34)
count == _TRUNCATElen >= sizeOfBuffer 尽可能多地写入 buffer 可容纳的字符串,以及终止 NULL -1 不可用
count == _TRUNCATElen < sizeOfBuffer 使用终止 NULL 将整个字符串写入 buffer 写入的字符数,不包括终止 NULL 不可用
format == NULL 未写入任何数据。 如果执行无效的参数处理程序后继续执行,则设置 errno 并返回负值。 -1 EINVAL (22)

有关这些和其他错误代码的信息,请参阅 _doserrnoerrno_sys_errlist_sys_nerr

重要

确保 format 不是用户定义的字符串。

从 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`

_snwprintf_s_snprintf_s的宽字符版本; _snwprintf_s 的指针参数是宽字符串。 _snwprintf_s 中对编码错误的检测可能与 _snprintf_s 中不同。 _snwprintf_s 就像 swprintf_s,将输出写入字符串,而非 FILE 类型的目标。

这些带有 _l 后缀的函数的版本相同,只不过它们使用传递的区域设置参数而不是当前线程区域设置。

在 C++ 中,使用这些函数由模板重载简化;重载可以自动推导出缓冲区长度 (不再需要指定大小自变量),并且它们可以自动用以更新、更安全的对应物替换旧的、不安全的函数。 有关详细信息,请参阅安全模板重载

一般文本例程映射

Tchar.h 例程 _UNICODE_MBCS 未定义 _MBCS 已定义 _UNICODE 已定义
_sntprintf_s _snprintf_s _snprintf_s _snwprintf_s
_sntprintf_s_l _snprintf_s_l _snprintf_s_l _snwprintf_s_l

要求

例程 必需的标头
_snprintf_s_snprintf_s_l <stdio.h>
_snwprintf_s_snwprintf_s_l <stdio.h><wchar.h>

有关兼容性的详细信息,请参阅 兼容性

示例

// crt_snprintf_s.cpp
// compile with: /MTd

// These #defines enable secure template overloads
// (see last part of Examples() below)
#define _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES 1
#define _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES_COUNT 1

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <crtdbg.h>  // For _CrtSetReportMode
#include <errno.h>

// This example uses a 10-byte destination buffer.

int snprintf_s_tester( const char * fmt, int x, size_t count )
{
   char dest[10];

   printf( "\n" );

   if ( count == _TRUNCATE )
      printf( "%zd-byte buffer; truncation semantics\n",
               _countof(dest) );
   else
      printf( "count = %zd; %zd-byte buffer\n",
               count, _countof(dest) );

   int ret = _snprintf_s( dest, _countof(dest), count, fmt, x );

   printf( "    new contents of dest: '%s'\n", dest );

   return ret;
}

void Examples()
{
   // formatted output string is 9 characters long: "<<<123>>>"
   snprintf_s_tester( "<<<%d>>>", 121, 8 );
   snprintf_s_tester( "<<<%d>>>", 121, 9 );
   snprintf_s_tester( "<<<%d>>>", 121, 10 );

   printf( "\nDestination buffer too small:\n" );

   snprintf_s_tester( "<<<%d>>>", 1221, 10 );

   printf( "\nTruncation examples:\n" );

   int ret = snprintf_s_tester( "<<<%d>>>", 1221, _TRUNCATE );
   printf( "    truncation %s occur\n", ret == -1 ? "did"
                                                  : "did not" );

   ret = snprintf_s_tester( "<<<%d>>>", 121, _TRUNCATE );
   printf( "    truncation %s occur\n", ret == -1 ? "did"
                                                  : "did not" );
   printf( "\nSecure template overload example:\n" );

   char dest[10];
   _snprintf( dest, 10, "<<<%d>>>", 12321 );
   // With secure template overloads enabled (see #defines
   // at top of file), the preceding line is replaced by
   //    _snprintf_s( dest, _countof(dest), 10, "<<<%d>>>", 12345 );
   // Instead of causing a buffer overrun, _snprintf_s invokes
   // the invalid parameter handler.
   // If secure template overloads were disabled, _snprintf would
   // write 10 characters and overrun the dest buffer.
   printf( "    new contents of dest: '%s'\n", dest );
}

void myInvalidParameterHandler(
   const wchar_t* expression,
   const wchar_t* function,
   const wchar_t* file,
   unsigned int line,
   uintptr_t pReserved)
{
   wprintf(L"Invalid parameter handler invoked: %s\n", expression);
}

int main( void )
{
   _invalid_parameter_handler oldHandler, newHandler;

   newHandler = myInvalidParameterHandler;
   oldHandler = _set_invalid_parameter_handler(newHandler);
   // Disable the message box for assertions.
   _CrtSetReportMode(_CRT_ASSERT, 0);

   Examples();
}

count = 8; 10-byte buffer
    new contents of dest: '<<<121>>'

count = 9; 10-byte buffer
    new contents of dest: '<<<121>>>'

count = 10; 10-byte buffer
    new contents of dest: '<<<121>>>'

Destination buffer too small:

count = 10; 10-byte buffer
Invalid parameter handler invoked: ("Buffer too small", 0)
    new contents of dest: ''

Truncation examples:

10-byte buffer; truncation semantics
    new contents of dest: '<<<1221>>'
    truncation did occur

10-byte buffer; truncation semantics
    new contents of dest: '<<<121>>>'
    truncation did not occur

Secure template overload example:
Invalid parameter handler invoked: ("Buffer too small", 0)
    new contents of dest: ''

另请参阅

流 I/O
sprintf_sprintf_lswprintf_swprintf_l__swprintf_l
fprintf_fprintf_lfwprintf_fwprintf_l
printf_printf_lwprintf_wprintf_l
scanf_scanf_lwscanf_wscanf_l
sscanf_sscanf_lswscanf_swscanf_l
vprintf 函数