vsprintf_s， _vsprintf_s_l， vswprintf_s， _vswprintf_s_l

项目
02/21/2013

编写格式化输出使用指针参数列表。这些是 vsprintf， _vsprintf_l， vswprintf， _vswprintf_l， __vswprintf_l 的版本与安全增强的 CRT中的安全功能如中所述。

int vsprintf_s(
   char *buffer,
   size_t numberOfElements,
   const char *format,
   va_list argptr 
); 
int _vsprintf_s_l(
   char *buffer,
   size_t numberOfElements,
   const char *format,
   locale_t locale,
   va_list argptr 
); 
int vswprintf_s(
   wchar_t *buffer,
   size_t numberOfElements,
   const wchar_t *format,
   va_list argptr 
);
int _vswprintf_s_l(
   wchar_t *buffer,
   size_t numberOfElements,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);
template <size_t size>
int vsprintf_s(
   char (&buffer)[size],
   const char *format,
   va_list argptr 
); // C++ only
template <size_t size>
int vswprintf_s(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   va_list argptr 
); // C++ only

参数

buffer
输出的存储位置。
numberOfElements
buffer 的大小字符的。
format
格式规范。
argptr
列表的指针参数。
locale
使用的区域设置。

返回值

，如果输出错误，vsprintf_s 和 vswprintf_s 返回编写的字符数，不包括终止 null 字符) 或负值。如果 buffer 或 format 是 null 指针，因此，如果计数为零时，或者，如果格式字符串包含无效格式字符，无效参数调用处理程序，如参数验证所述。如果执行允许继续，函数返回 -1 并将 errno 到 EINVAL。

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

备注

这些功能中的每一个采用指向参数列表，然后布局和编写特定数据到内存指向由 buffer。

vswprintf_s 符合 vswprintf的 ISO C 标准，需要第二个参数， count，类型 size_t。

这些函数与不安全的版本上的不同之处在于安全版本支持位置的参数。有关更多信息，请参见 printf_p位置参数。

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

在 C++ 中，使用这些功能由模板重载简化;重载可推断缓冲区长度 (自动不再需要指定范围参数)，并且还可以用以较新，安全重复自动替换旧，不安全的功能。有关更多信息，请参见安全模板重载。

一般文本例程映射

TCHAR.H 实例	未定义的 _UNICODE _MBCS	定义的 _MBCS	定义的 _UNICODE
_vstprintf_s	vsprintf_s	vsprintf_s	vswprintf_s
_vstprintf_s_l	_vsprintf_s_l	_vsprintf_s_l	_vswprintf_s_l

要求

实例	必需的头	可选标头
vsprintf_s, _vsprintf_s_l	stdio.h 和 stdarg.h	varargs.h*
vswprintf_s, _vswprintf_s_l	stdio.h 或者 wchar.h，和 stdarg.h	varargs.h*

* 仅对 UNIX v 兼容性。

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

示例

// crt_vsprintf_s.c
// This program uses vsprintf_s to write to a buffer.
// The size of the buffer is determined by _vscprintf.

#include <stdlib.h>
#include <stdarg.h>

void test( char * format, ... )
{
   va_list args;
   int len;
   char * buffer;

   va_start( args, format );
   len = _vscprintf( format, args ) // _vscprintf doesn't count
                               + 1; // terminating '\0'
   buffer = malloc( len * sizeof(char) );
   vsprintf_s( buffer, len, format, args );
   puts( buffer );
   free( buffer );
}

int main( void )
{
   test( "%d %c %d", 123, '<', 456 );
   test( "%s", "This is a string" );
}