vsnprintf， _vsnprintf， _vsnprintf_l， _vsnwprintf， _vsnwprintf_l

项目
02/21/2013

编写格式化输出使用指针参数列表。这些功能的更安全版本可用; 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
的最大字符数写入的。
format
格式规范。
argptr
列表的指针参数。
locale
使用的区域设置。

有关更多信息，请参见格式规范。

返回值

vsnprintf、_vsnprintf和 _vsnwprintf 返回编写的字符数字符数编写是否小于或等于 count;如果字符数编写于 count大，这些函数返回指示 -1 的输出被截断。，如果一个用于编写，返回值不包括终止 null。

如果 buffer 或 format 是 NULL，或者，如果计数小于或等于零，这些函数调用的参数无效处理程序，如参数验证所述。如果执行允许继续，这些函数返回 -1 并将 errno 到 EINVAL。

备注

这些功能中的每一个采用指向参数列表，然后设置数据格式，并记载到 count 字符到内存指向由 buffer。如果有空格在末尾 (即，如果字符数编写于 count小于)，缓冲区将 null 结尾。

安全说明
确保 format 不是用户定义的字符串。有关更多信息，请参见避免缓冲区溢出。

备注

为了确保具有停止的空白，请确保 count 大于缓冲区长度严格小于和缓冲区初始化为空在调用函数之前。

vsnprintf 与 _vsnprintf相同。 vsnprintf 用于标准包括于 ANSI 标准; _vnsprintf 备向后兼容。

这些功能的版本与 _l 后缀的相同，只不过它们使用区域设置参数而不是当前线程区域设置。

在 C++ 中，这些函数的调用的模板重载越+新，保证这些函数副本。有关更多信息，请参见安全模板重载。

一般文本例程映射

TCHAR.H 实例	未定义的 _UNICODE _MBCS	定义的 _MBCS	定义的 _UNICODE
_vsntprintf	_vsnprintf	_vsnprintf	_vsnwprintf
_vsntprintf_l	_vsnprintf_l	_vsnprintf_l	_vsnwprintf_l

要求

实例	必需的头	可选标头
vsnprintf	stdio.h 和 stdarg.h	varargs.h*
_vsnprintf, _vsnprintf_l	stdio.h 和 stdarg.h	varargs.h*
_vsnwprintf, _vsnwprintf_l	stdio.h 或者 wchar.h，和 stdarg.h	varargs.h*

* 仅对 UNIX v 兼容性。

有关其他的兼容性信息，请参见中介绍的兼容性。

示例

// crt_vsnprintf.cpp
// compile with: /W3
#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( buff, sizeof(buff) - 1, formatstring, args); // C4996
// Note: vsnprintf is deprecated; consider vsnprintf_s instead
   printf("nSize: %d, buff: %s\n", nSize, buff);
}

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