vsprintf、_vsprintf_l、vswprintf、_vswprintf_l、__vswprintf_l

發行項
06/09/2015

使用指向一個引數清單的指標輸出格式化的字串更多這些函式的可用安全版本，請參閱 vsprintf_s、_vsprintf_s_l、vswprintf_s、_vswprintf_s_l。

int vsprintf(
   char *buffer,
   const char *format,
   va_list argptr 
); 
int _vsprintf_l(
   char *buffer,
   const char *format,
   locale_t locale,
   va_list argptr 
); 
int vswprintf(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   va_list argptr 
);
int _vswprintf_l(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);
int __vswprintf_l(
   wchar_t *buffer,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);
template <size_t size>
int vsprintf(
   char (&buffer)[size],
   const char *format,
   va_list argptr 
); // C++ only
template <size_t size>
int _vsprintf_l(
   char (&buffer)[size],
   const char *format,
   locale_t locale,
   va_list argptr 
); // C++ only
template <size_t size>
int vswprintf(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   va_list argptr 
); // C++ only
template <size_t size>
int _vswprintf_l(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
); // C++ only

參數

buffer
輸出的儲存位置。
count
在UNICODE版本中儲存的最大字元數。
format
格式規範。
argptr
參數清單的指標。
locale
使用的地區設定。

傳回值

vsprintf 和 vswprintf 回傳寫入的字元數，不包含結尾的空字元，或者在輸出發生錯誤時回傳一個負值。如果 buffer 或 format 為 null 指標，則這些函示叫用無效參數處理常式，如參數驗證中所述。如果允許繼續執行，這些函式會傳回 -1 並將errno 設定為 EINVAL。

如需有關這些錯誤碼和其他錯誤碼的詳細資訊，請參閱 _doserrno、errno、_sys_errlist 和 _sys_nerr。

備註

這些函式接受一個指向參數清單的指標，格式化並將給定的資料寫入到 buffer 所指向的記憶體。

尾碼為 _l 的這些函式版本是一樣的，只不過它們使用傳入的地區設定，而不是目前執行緒的地區設定。

安全性提示
使用 vsprintf 時，無法限制寫入的字元數目，這表示使用的程式碼很容易發生緩衝區滿溢。使用 _vsnprintf 或 _vscprintf 呼叫判斷多大的緩衝區是必要的。此外，還要確保 format 不是使用者定義的字串。如需詳細資訊，請參閱 Avoiding Buffer Overruns 。

vswprintf 符合 ISO C 語言標準，此標準要求第二個參數 count 的類型必須為 size_t。若要強制舊的非標準行為，請定義_CRT_NON_CONFORMING_SWPRINTFS. ，舊的行為可能不會在未來的版本中，因此應該變更程式碼以使用新的行為。

在 C++ 中，這些函式具有多載樣板，可以叫用更新、更安全的這些函式的相對版本。如需詳細資訊，請參閱安全範本多載。

一般文字常式對應

TCHAR.H 常式	未定義 _UNICODE & _MBCS	已定義 _MBCS	已定義 _UNICODE
_vstprintf	vsprintf	vsprintf	vswprintf
_vstprintf_l	_vsprintf_l	_vsprintf_l	_vswprintf_l

需求

常式	必要的標頭	選擇性的標頭檔
vsprintf, _vsprintf_l	<stdio.h> 和 <stdarg.h>	<varargs.h>*
vswprintf, _vswprintf_l	<stdio.h> 或 <wchar.h>, 及 <stdarg.h>	<varargs.h>*

* 要求 UNIX V 相容性。

如需其他相容性資訊，請參閱＜簡介＞中的相容性。

範例

// crt_vsprintf.c
// compile with: /W3
// This program uses vsprintf 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 * format, ... )
{
    va_list args;
    int     len;
    char    *buffer;

    // retrieve the variable arguments
    va_start( args, format );
    
    len = _vscprintf( format, args ) // _vscprintf doesn't count
                                + 1; // terminating '\0'
    
    buffer = (char*)malloc( len * sizeof(char) );

    vsprintf( buffer, format, args ); // C4996
    // Note: vsprintf is deprecated; consider using vsprintf_s instead
    puts( buffer );

    free( buffer );
}

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