使用指向参数列表的指针写入格式化的输出。 这些函数的版本是 vsnprintf_vsnprintf_vsnprintf_l_vsnwprintf_vsnwprintf_l,具有安全性增强功能,如 CRT 中的安全功能中所述。

语法

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

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

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

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

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

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

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

参数

buffer
输出的存储位置

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

count
要写入的字符最大数量,不包括终止 NULL。 对于采用 wchar_t 的函数,要写入的宽字符数。 或 _TRUNCATE

format
格式规范。

argptr
指向参数列表的指针。

locale
设置输出格式时要使用的区域设置。

有关更多信息,请参阅格式规范

返回值

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

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

注解

vsnprintf_s_vsnprintf_s 相同,为符合 ANSI 标准,将其包括在内。 为实现后向兼容性保留了 _vnsprintf

这些函数中的每一个函数都将采用指向参数列表的指针,然后进行格式化并将给定数据的多达 count 个字符写入 buffer 指向的内存中并追加一个终止 null。

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

行为摘要

对于下表:

  • len 设置为格式化数据的大小。 如果函数采用 char 缓冲区,则大小以字节为单位。 如果函数采用 wchar_t 缓冲区,则大小指定 16 位字的数目。
  • 字符是指采用 char 缓冲区的函数的 char 字符,以及采用 wchar_t 缓冲区的函数 wchar_t 字符。
  • 有关无效参数处理程序的详细信息,请参阅参数验证
条件 行为 返回值 errno 调用无效参数处理程序
成功 使用指定的格式字符串将字符写入缓冲区 写入的字符数 不可用
格式设置过程中的编码错误 如果处理字符串说明符 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 未写入任何数据。 如果执行无效的参数处理程序后继续执行,则设置 errno 并返回负值。 -1 EINVAL (22)
count == 0 不写入任何数据并返回已写入的字符数(不包括终止 NULL)。 将写入的字符数不包括终止 NULL 不可用
count < 0 不安全:该值被视为无符号值,可能会创建一个大值,导致覆盖缓冲区后面的内存。 写入的字符数,不包括终止 NULL 不可用
count < sizeOfBufferlen <= count 将写入所有数据,并追加终止 NULL 写入的字符数。 不可用
count < sizeOfBufferlen > count count 个字符已写入。 -1 不可用
count >= sizeOfBufferlen < sizeOfBuffer 所有数据都以终止 NULL 写入。 写入的字符数,不包括终止 NULL 不可用
count >= sizeOfBufferlen >= sizeOfBuffercount != _TRUNCATE 如果执行无效的参数处理程序后继续执行,则设置 errno、设置 buffer[0] == NULL 并返回负值。 -1 ERANGE (34)
count == _TRUNCATElen >= sizeOfBuffer 尽可能多地写入 buffer 可容纳的字符串,包括终止 NULL -1 不可用
count == _TRUNCATElen < sizeOfBuffer 使用终止 NULL 将整个字符串写入 buffer 写入的字符数。 不可用
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`

注意

若要确保具有终止 null 的空间,请严格确保 count 小于缓冲区或使用 _TRUNCATE

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

提示

如果出现未定义的外部 _vsnprintf_s 错误并使用通用 C 运行时,请将 legacy_stdio_definitions.lib 添加到要链接的库集。 通用 C 运行时不会直接导出此函数,而是在 <stdio.h> 中内联定义。 有关详细信息,请参阅潜在的升级问题概述Visual Studio 2015 符合性更改

一般文本例程映射

TCHAR.H 例程 _UNICODE_MBCS 未定义 _MBCS 已定义 _UNICODE 已定义
_vsntprintf_s _vsnprintf_s _vsnprintf_s _vsnwprintf_s
_vsntprintf_s_l _vsnprintf_s_l _vsnprintf_s_l _vsnwprintf_s_l

要求

例程 必需的标头 可选标头
vsnprintf_s <stdio.h><stdarg.h> <varargs.h>*
%> <stdio.h><stdarg.h> <varargs.h>*
%> <stdio.h><wchar.h>,以及 <stdarg.h> <varargs.h>*

* 仅对 UNIX V 兼容性是必需的。

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

示例

// crt_vsnprintf_s.cpp
#include <stdio.h>
#include <wtypes.h>

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

int main() {
   FormatOutput("%s %s", "Hi", "there");
   FormatOutput("%s %s", "Hi", "there!");
   FormatOutput("%s %s", "Hi", "there!!");
}
nSize: 8, buff: Hi there
nSize: 9, buff: Hi there!
nSize: -1, buff: Hi there!

另请参阅

流 I/O
vprintf 函数