vsnprintf, _vsnprintf, _vsnprintf_l, _vsnwprintf, _vsnwprintf_l

  • 项目

使用指向参数列表的指针写入格式化的输出。 提供这些函数的更安全版本；请参阅 vsnprintf_s、_vsnprintf_s、_vsnprintf_s_l、_vsnwprintf_s、_vsnwprintf_s_l。

语法

int vsnprintf(
   char *buffer,
   size_t count,
   const char *format,
   va_list argptr
);

int _vsnprintf(
   char *buffer,
   size_t count,
   const char *format,
   va_list argptr
);

int _vsnprintf_l(
   char *buffer,
   size_t count,
   const char *format,
   _locale_t locale,
   va_list argptr
);

int _vsnwprintf(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   va_list argptr
);

int _vsnwprintf_l(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   _locale_t locale,
   va_list argptr
);

template <size_t size>
int vsnprintf(
   char (&buffer)[size],
   size_t count,
   const char *format,
   va_list argptr
); // C++ only

template <size_t size>
int _vsnprintf(
   char (&buffer)[size],
   size_t count,
   const char *format,
   va_list argptr
); // C++ only

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

template <size_t size>
int _vsnwprintf(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format,
   va_list argptr
); // C++ only

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

参数

buffer
输出的存储位置

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

format
格式规范。

argptr
指向参数列表的指针。

locale
要使用的区域设置。

有关详细信息，请参阅格式规范语法。

返回值

已写入的字符数（不包括终止 NULL），如果发生输出错误，则返回负值。

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

备注

这些函数中的每一个函数都将采用指向参数列表的指针，然后设置数据的格式并将多达 count 个字符写入 buffer 指向的内存中。 vsnprintf 函数始终会写入一个 null 终止符，即使它截断输出。 使用 _vsnprintf 和 _vsnwprintf 时，仅当结尾处有空间（即，如果要写入的字符数小于 count）时，缓冲区才会以 null 终止。

从 Visual Studio 2015 和 Windows 10 中的 UCRT 开始， vsnprintf 不再等于 _vsnprintf。 vsnprintf 函数遵循 C99 标准；保留 _vsnprintf 以实现与旧版代码的向后兼容性。 区别在于，如果缓冲区耗尽，vsnprintf 会以 null 终止缓冲区的末尾并返回所需的字符数，_vsnprintf 则不会以 null 终止缓冲区，并会返回 -1。 此外，_vsnprintf() 在输出中包含一个字符，因为它不会以 null 终止缓冲区。

重要

为了防止某些类型的安全风险，请确保 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`。

注意

若要确保调用 _vsnprintf、_vsnprintf_l、_vsnwprintf 和 _vsnwprintf_l 时有空间容纳终止 null，请确保 count 严格小于缓冲区长度并在调用此函数之前将缓冲区初始化为 null。

因为 vsnprintf 始终会写入终止 null，因此 count 参数可能等于缓冲区大小。

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

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

行为摘要

对于下表：

  • 将 sizeOfBuffer 设置为 buffer 的大小。 如果函数采用 char 缓冲区，则大小以字节为单位。 如果函数采用 wchar_t 缓冲区，则大小指定 16 位字的数目。
  • 将 len 设置为格式化数据的大小。 如果函数采用 char 缓冲区，则大小以字节为单位。 如果函数采用 wchar_t 缓冲区，则大小指定 16 位字的数目。
  • 字符是指采用 char 缓冲区的函数的 char 字符，以及采用 wchar_t 缓冲区的函数 wchar_t 字符。
  • 有关无效参数处理程序的详细信息，请参阅参数验证。
条件 行为 返回值 errno 调用无效参数处理程序
Success 使用指定的格式字符串将字符写入缓冲区。 写入的字符数，不包括终止 null 字符。 不可用 否
格式设置过程中的编码错误 如果处理字符串说明符 s、S 或 Z，格式规范处理将停止。 -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。

一般文本例程映射

TCHAR.H 例程 _UNICODE 和 _MBCS 未定义 _MBCS 已定义 _UNICODE 已定义
_vsntprintf _vsnprintf _vsnprintf _vsnwprintf
_vsntprintf_l _vsnprintf_l _vsnprintf_l _vsnwprintf_l

要求

例程 必需的标头 (C) 必需的标头 (C++)
vsnprintf, _vsnprintf, _vsnprintf_l <stdio.h> <stdio.h> 或 <cstdio>
_vsnwprintf，_vsnwprintf_l <stdio.h> 或 <wchar.h> <stdio.h>、<wchar.h>、<cstdio> 或 <cwchar>

_vsnprintf、_vsnprintf_l、_vsnwprintf 和 _vsnwprintf_l 函数是 Microsoft 特定函数。 有关兼容性的详细信息，请参阅 兼容性。

示例：将宽字符与 _vsnwprintf() 结合使用

// crt_vsnwprintf.c
// compile by using: cl /W3 crt_vsnwprintf.c

// To turn off error C4996, define this symbol:
#define _CRT_SECURE_NO_WARNINGS

#include <stdio.h>
#include <wtypes.h>

#define BUFFCOUNT (10)

void FormatOutput(LPCWSTR formatstring, ...)
{
    int nSize = 0;
    wchar_t buff[BUFFCOUNT];
    memset(buff, 0, sizeof(buff));
    va_list args;
    va_start(args, formatstring);
    // Note: _vsnwprintf is deprecated; consider vsnwprintf_s instead
    nSize = _vsnwprintf(buff, BUFFCOUNT - 1, formatstring, args); // C4996
    wprintf(L"nSize: %d, buff: %ls\n", nSize, buff);
    va_end(args);
}

int main() {
    FormatOutput(L"%ls %ls", L"Hi", L"there");
    FormatOutput(L"%ls %ls", L"Hi", L"there!");
    FormatOutput(L"%ls %ls", L"Hi", L"there!!");
}

nSize: 8, buff: Hi there
nSize: 9, buff: Hi there!
nSize: -1, buff: Hi there!

如果使用 vsnprintf 以及窄字符串参数代替，结果会发生更改。 count 参数可以是整个缓冲区的大小，如果 count 足够大，返回值将会是已写入的字符数：

示例：将 vsnprintf() 与窄字符串结合使用

// crt_vsnprintf.c
// compile by using: cl /W4 crt_vsnprintf.c
#include <stdio.h>
#include <stdarg.h> // for va_list, va_start
#include <string.h> // for memset

#define BUFFCOUNT (10)

void FormatOutput(char* formatstring, ...)
{
    int nSize = 0;
    char buff[BUFFCOUNT];
    memset(buff, 0, sizeof(buff));
    va_list args;
    va_start(args, formatstring);
    nSize = vsnprintf(buff, sizeof(buff), formatstring, args);
    printf("nSize: %d, buff: %s\n", nSize, buff);
    va_end(args);
}

int main() {
    FormatOutput("%s %s", "Hi", "there");   //  8 chars + null
    FormatOutput("%s %s", "Hi", "there!");  //  9 chars + null
    FormatOutput("%s %s", "Hi", "there!!"); // 10 chars + null
}

nSize: 8, buff: Hi there
nSize: 9, buff: Hi there!
nSize: 10, buff: Hi there!

另请参阅

流 I/O
vprintf 函数
格式规范语法：printf 和 wprintf 函数
fprintf、_fprintf_l、fwprintf、_fwprintf_l
printf、_printf_l、wprintf、_wprintf_l
sprintf、_sprintf_l、swprintf、_swprintf_l、__swprintf_l
va_arg、va_copy、va_end、va_start