使用指向参数列表的指针写入格式化输出。 这些函数是 、 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
for 输出的大小 buffer 。 采用 的函数的大小(以字节为单位),采用 的函数的char字的大小(以wchar_t为单位)。
count
要写入的最大字符数,不包括终止字符 NULL。 对于采用 的 wchar_t函数,它是要写入的宽字符数。 或 _TRUNCATE.
format
格式规范。
argptr
指向参数列表的指针。
locale
格式化输出时要使用的区域设置。
有关更多信息,请参阅 格式规范。
返回值
写入的字符数,不包括 terminating NULL,如果发生输出错误,则不包括负值。
有关详细信息,请参阅 行为摘要 。
注解
这些函数中的每一个都采用指向参数列表的指针,然后将给定数据的字符格式化并写入 count 指向的 buffer 内存,并附加一个终止 NULL.
在调试版本中,终止sizeOfBuffer后的剩余NULL字节用“xFE”填充,如 _CrtSetDebugFillThreshold中所述。
这些带有 _l 后缀的函数的版本是相同的,只是它们使用传入的 locale 参数,而不是当前线程区域设置。
vsnprintf_s 与 ANSI 标准相同 _vsnprintf_s ,并且为了符合 ANSI 标准而包含在内。
_vnsprintf 保留以实现向后兼容性。
行为摘要
对于下表:
- 设
len为格式化数据的大小。 如果函数占用char缓冲区,则大小以字节为单位。 如果函数占用缓冲区wchar_t,则 size 指定 16 位字的数量。 - 字符是指
char占用char缓冲区的函数的字符,wchar_t以及占用wchar_t缓冲区的函数的字符。 - 有关无效参数处理程序的更多信息,请参阅 参数验证。
| 条件 | 行为 | 返回值 | errno |
调用无效的参数处理程序 |
|---|---|---|---|---|
| 成功 | 使用指定的格式字符串将字符写入缓冲区 | 写入的字符数 | 无 | 否 |
| 格式化过程中出现编码错误 | 如果处理字符串说明符 s、 S、 或 Z格式规范处理将停止。 |
-1 | EILSEQ (42) |
否 |
| 格式化过程中出现编码错误 | 如果处理字符说明符 c 或 C,则会跳过无效字符。 写入的字符数不会为跳过的字符递增,也不会为其写入任何数据。 跳过出现编码错误的说明符后,将继续处理格式规范。 |
写入的字符数,不包括终止 NULL字符数 。 |
EILSEQ (42) |
否 |
buffer == NULL以及sizeOfBuffer == 0count == 0 |
不写入任何数据。 | 0 | 无 | 否 |
buffer == NULL和 或sizeOfBuffer != 0count != 0 |
如果在无效参数处理程序执行后继续执行,则设置 errno 并返回负值。 |
-1 |
EINVAL (22) |
是的 |
buffer != NULL 和 sizeOfBuffer == 0 |
不写入任何数据。 如果在无效参数处理程序执行后继续执行,则设置 errno 并返回负值。 |
-1 |
EINVAL (22) |
是的 |
buffer != NULL以及sizeOfBuffer != 0count == 0 |
缓冲区终止 NULL 。 |
-1 | 无 | 否 |
count == 0 |
不写入任何数据,并返回本应写入的字符数,不包括终止 NULL. |
本应写入的字符数,不包括终止 NULL. |
无 | 否 |
count < 0 |
Unsafe:该值被视为 unsigned,可能会创建一个较大的值,从而导致覆盖缓冲区后面的内存。 | 写入的字符数,不包括终止 NULL字符数 。 |
无 | 否 |
count < sizeOfBuffer 和 len <= count |
写入所有数据并附加终止 NULL 。 |
写入的字符数。 | 无 | 否 |
count < sizeOfBuffer 和 len > count |
将写入第一个 count 字符。 |
-1 | 无 | 否 |
count >= sizeOfBuffer 和 len < sizeOfBuffer |
所有数据都使用终止 NULL. |
写入的字符数,不包括终止 NULL字符数 。 |
无 | 否 |
count >= sizeOfBuffer以及len >= sizeOfBuffercount != _TRUNCATE |
如果在无效参数处理程序执行后继续执行,则 sets errno、 sets buffer[0] == NULL并返回负值。 |
-1 |
ERANGE (34) |
是的 |
count == _TRUNCATE 和 len >= sizeOfBuffer |
写入 中适合 buffer的字符串,包括终止 NULL. |
-1 | 无 | 否 |
count == _TRUNCATE 和 len < sizeOfBuffer |
使用 terminating buffer将整个字符串NULL写入 。 |
写入的字符数。 | 无 | 否 |
format == NULL |
不写入任何数据。 如果在无效参数处理程序执行后继续执行,则设置 errno 并返回负值。 |
-1 |
EINVAL (22) |
是的 |
有关这些错误代码和其他错误代码的信息,请参阅 _doserrno、 errno、 _sys_errlist和 _sys_nerr。
重要
确保它 format 不是用户定义的字符串。 有关更多信息,请参阅 避免缓冲区溢出。
从 Windows 10 版本 2004(内部版本 19041)开始, printf 函数系列根据 IEEE 754 四舍五入规则打印精确表示的浮点数。 在早期版本的 Windows 中,以“5”结尾的精确表示的浮点数将始终四舍五入。 IEEE 754 规定它们必须四舍五入到最接近的偶数位(也称为“Banker's Rounding”)。 例如,both printf("%1.0f", 1.5) 和 printf("%1.0f", 2.5) 都应该四舍五入为 2。 以前,1.5 将四舍五入为 2,而 2.5 将四舍五入为 3。 此更改仅影响完全可表示的数字。 例如,2.35(在内存中表示时,更接近 2.350000000000000008)继续向上舍入到 2.4。 这些函数完成的舍入现在也遵循 设置的 fesetround浮点舍入模式。 以前,舍入始终选择 FE_TONEAREST behavior。 此更改仅影响使用 Visual Studio 2019 版本 16.2 及更高版本构建的程序。 若要使用旧浮点舍入行为,请链接到 legacy_stdio_float_rounding.obj。
注释
要确保有空间用于 termination NULL,请确保 严格 count 小于缓冲区长度,或使用 _TRUNCATE。
在 C++ 中,模板重载简化了这些函数的使用;重载可以自动推断缓冲区长度(无需指定 size 参数),并且可以自动将较旧的非安全函数替换为更新的安全函数。 有关详细信息,请参阅安全模板重载。
小窍门
如果您收到未定义的外部 _vsnprintf_s 错误,并且正在使用 Universal C Runtime,请添加到 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>* |
_vsnprintf_s、_vsnprintf_s_l |
<stdio.h> 和 <stdarg.h> |
<varargs.h>* |
_vsnwprintf_s、_vsnwprintf_s_l |
<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 函数
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