vsprintf_s, _vsprintf_s_l, vswprintf_s, _vswprintf_s_l

  • 项目

使用指向参数列表的指针写入格式化的输出。 这些函数是 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 为空指针、numberOfElements 为零或者 format 字符串包含无效的格式字符，则将调用无效参数处理程序，如参数验证中所述。 如果允许执行继续，则这些函数将返回 -1 并将 errno 设置为 EINVAL。

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

注解

这些函数中的每一个函数都将采用指向参数列表的指针，然后设置给定数据的格式并将其写入 buffer 指向的内存中。

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

这些函数与不安全版本的差异仅在于安全版本支持位置参数。 有关详细信息，请参阅 printf_p 位置参数。

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

在 C++ 中，通过模板重载可简化这些函数的使用。 重载可自动推导出缓冲区的长度，不再需要指定大小参数。 而且，它们可以自动将非安全函数替换为对应的安全函数。 有关详细信息，请参阅安全模板重载。

重要

从 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`。

一般文本例程映射

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
// Compile with: cl /W4 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 <stdio.h>
#include <stdarg.h>

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

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

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

123 < 456
This is a string

另请参阅

流 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