snprintf、_snprintf、_snprintf_l、_snwprintf、_snwprintf_l

项目
08/03/2024

将格式化的数据写入字符串。这些功能有更安全的版本可用；请参阅 _snprintf_s、_snprintf_s_l、_snwprintf_s、_snwprintf_s_l。

语法

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

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

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

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

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

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

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

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

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

参数

buffer
输出的存储位置。

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

format
窗体控件字符串。

argument
可选参数。

locale
用于设置输出格式的区域设置。

有关详细信息，请参阅格式规范语法：printf 和 wprintf 函数。

返回值

已写入缓冲区的字符数（如果忽略了 count）。计数不包括终止 NULL 字符。

将 len 设为格式化数据字符串的长度，不包括终止 NULL。
对于所有函数，如果 len < count，则 len 字符存储在 buffer 中，将追加 null 终止符，并返回写入的字符数（不包括终止 NULL）。

这些函数的宽字符版本返回写入的宽字符数，不包括终止 NULL。

有关详细信息，请参阅行为摘要。

备注

从 Visual Studio 2015 和 Windows 10 中的 UCRT 开始， snprintf 不再等于 _snprintf。 snprintf 行为现在符合 C99 标准。区别在于，如果缓冲区耗尽，snprintf 会以 null 终止缓冲区的末尾并返回所需的字符数，_snprintf 则不会以 null 终止缓冲区，并会返回 -1。此外，snprintf() 在输出中包含一个字符，因为它不会以 null 终止缓冲区。

snprintf 和 _snprintf 系列函数在 buffer 中格式化和存储 count 或更少字符。
snprintf 始终存储终止 NULL 字符，并在必要时截断输出。
如果 snprintf 返回值 >count - 1，则输出已被截断。
仅当格式化字符串的长度严格小于 count 个字符时，_snprintf 系列函数才附加终止 NULL 字符。
每个 argument （如果有）根据 format中相应的格式规范进行转换和输出。该格式包括普通字符，其形式和函数与 format 的 printf 参数相同。如果在重叠的字符串之间发生复制，则此行为不确定。

行为摘要

对于下表：

将 sizeOfBuffer 设置为 buffer 的大小。如果函数采用 char 缓冲区，则大小以字节为单位。如果函数采用 wchar_t 缓冲区，则大小指定 16 位字的数目。
将 len 设置为格式化数据的大小。如果函数采用 char 缓冲区，则大小以字节为单位。如果函数采用 wchar_t 缓冲区，则大小指定 16 位字的数目。
字符是指采用 char 缓冲区的函数的 char 字符，以及采用 wchar_t 缓冲区的函数 wchar_t 字符。
有关无效参数处理程序的详细信息，请参阅参数验证。

条件	行为	返回值	`errno`	调用无效参数处理程序
Success	使用指定的格式字符串将字符写入缓冲区。	写入的字符数。	不可用	否
格式设置过程中的编码错误	如果处理字符串说明符 `s`、`S` 或 `Z`，格式规范处理停止，在缓冲区的开头放置一个 `NULL`。	-1	`EILSEQ` (42)	否
格式设置过程中的编码错误	如果处理字符说明符 `c` 或 `C`，则会跳过无效字符。为跳过的字符写入的字符数不会递增，也不会为它写入任何数据。跳过说明符并出现编码错误后，继续处理格式规范。	写入的字符数，不包括终止 `NULL`。	`EILSEQ` (42)	否
`buffer == NULL` 和 `count != 0`	如果执行无效的参数处理程序后继续执行，则设置 `errno` 并返回负值。	-1	`EINVAL` (22)	是
`count == 0`	将写入的字符数，不包括终止 `NULL`。可以将此结果用于为字符串和终止 `NULL` 分配足够的缓冲区空间，然后再次调用可填充缓冲区的函数。	不可用	否
`count < 0`	不安全：该值被视为无符号值，可能会创建一个大值，导致覆盖缓冲区后面的内存。	写入的字符数	不可用	否
`count < sizeOfBuffer` 和 `len <= count`	将写入所有数据，并追加终止 `NULL`。	写入的字符数，不包括终止 `NULL`。	不可用	否
`count < sizeOfBuffer` 和 `len > count`	将写入前 `count-1` 个字符，后跟 null 终止符。	将写入的字符数中有 `count` 个与输出的字符数匹配，不包括 null 终止符。	不可用	否
`count >= sizeOfBuffer` 和 `len < sizeOfBuffer`	所有数据都以终止 `NULL` 写入。	写入的字符数，不包括终止 `NULL`。	不可用	否
`count >= sizeOfBuffer` 和 `len >= sizeOfBuffer`	不安全：覆盖缓冲区后面的内存。	写入的字符数，不包括终止 `NULL`。	不可用	否
`format == NULL`	未写入任何数据。如果执行无效的参数处理程序后继续执行，则设置 `errno` 并返回负值。	-1	`EINVAL` (22)	是

有关这些和其他错误代码的信息，请参阅、_doserrno、errno、_sys_errlist 和 _sys_nerr。

重要

确保 format 不是用户定义的字符串。由于 _snprintf 函数不保证 null 终止，特别是返回值为 count时，因此请确保在其后追加用于添加 null 终止符的代码。有关详细信息，请参阅避免缓冲区溢出。

从 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 是 _snprintf的宽字符版本； _snwprintf 的指针参数是宽字符串。 _snwprintf 中的编码错误检测可能与 _snprintf 中的检测不同。 _snwprintf就像 swprintf，将输出写入字符串，而非 FILE类型的目标。

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

在 C++ 中，这些函数具有模板重载，可调用更新、更安全的版本。有关详细信息，请参阅安全模板重载。

一般文本例程映射

`Tchar.h` 例程	`_UNICODE` 和 `_MBCS` 未定义	`_MBCS` 已定义	`_UNICODE` 已定义
`_sntprintf`	`_snprintf`	`_snprintf`	`_snwprintf`
`_sntprintf_l`	`_snprintf_l`	`_snprintf_l`	`_snwprintf_l`

要求

例程	必需的标头
.- .	`<stdio.h>`
%>	`<stdio.h>` 或 `<wchar.h>`

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

示例

// crt_snprintf.c
// compile with: /W3
#include <stdio.h>
#include <stdlib.h>

#if !defined(__cplusplus)
typedef int bool;
const bool true = 1;
const bool false = 0;
#endif

#define FAIL 0 // change to 1 and see what happens

int main(void)
{
   char buffer[200];
   const static char s[] = "computer"
#if FAIL
"computercomputercomputercomputercomputercomputercomputercomputer"
"computercomputercomputercomputercomputercomputercomputercomputer"
"computercomputercomputercomputercomputercomputercomputercomputer"
"computercomputercomputercomputercomputercomputercomputercomputer"
#endif
   ;
   const char c = 'l';
   const int i = 35;
#if FAIL
   const double fp = 1e300; // doesn't fit in the buffer
#else
   const double fp = 1.7320534;
#endif
   /* !subtract one to prevent "squeezing out" the terminal null! */
   const int bufferSize = sizeof(buffer)/sizeof(buffer[0]) - 1;
   int bufferUsed = 0;
   int bufferLeft = bufferSize - bufferUsed;
   bool bSuccess = true;
   buffer[0] = 0;

   /* Format and print various data: */

   if (bufferLeft > 0)
   {
      int perElementBufferUsed = _snprintf(&buffer[bufferUsed],
      bufferLeft, "   String: %s\n", s ); // C4996
      // Note: _snprintf is deprecated; consider _snprintf_s instead
      if (bSuccess = (perElementBufferUsed >= 0))
      {
         bufferUsed += perElementBufferUsed;
         bufferLeft -= perElementBufferUsed;
         if (bufferLeft > 0)
         {
            int perElementBufferUsed = _snprintf(&buffer[bufferUsed],
            bufferLeft, "   Character: %c\n", c ); // C4996
            if (bSuccess = (perElementBufferUsed >= 0))
            {
               bufferUsed += perElementBufferUsed;
               bufferLeft -= perElementBufferUsed;
               if (bufferLeft > 0)
               {
                  int perElementBufferUsed = _snprintf(&buffer
                  [bufferUsed], bufferLeft, "   Integer: %d\n", i ); // C4996
                  if (bSuccess = (perElementBufferUsed >= 0))
                  {
                     bufferUsed += perElementBufferUsed;
                     bufferLeft -= perElementBufferUsed;
                     if (bufferLeft > 0)
                     {
                        int perElementBufferUsed = _snprintf(&buffer
                        [bufferUsed], bufferLeft, "   Real: %f\n", fp ); // C4996
                        if (bSuccess = (perElementBufferUsed >= 0))
                        {
                           bufferUsed += perElementBufferUsed;
                        }
                     }
                  }
               }
            }
         }
      }
   }

   if (!bSuccess)
   {
      printf("%s\n", "failure");
   }
   else
   {
      /* !store null because _snprintf doesn't necessarily (if the string
       * fits without the terminal null, but not with it)!
       * bufferUsed might be as large as bufferSize, which normally is
       * like going one element beyond a buffer, but in this case
       * subtracted one from bufferSize, so we're ok.
       */
      buffer[bufferUsed] = 0;
      printf( "Output:\n%s\ncharacter count = %d\n", buffer, bufferUsed );
   }
   return EXIT_SUCCESS;
}

Output:
   String: computer
   Character: l
   Integer: 35
   Real: 1.732053

character count = 69

另请参阅

流 I/O

vprintf 函数

通过

语法

参数

返回值

备注

行为摘要

一般文本例程映射

要求

示例

另请参阅

反馈

其他资源