vsnprintf_s, _vsnprintf_s, _vsnprintf_s_l, _vsnwprintf_s, _vsnwprintf_s_l

使用引數清單的指標，寫入格式化輸出。 這些函式是 、 _vsnprintf 、 _vsnprintf_l 、 _vsnwprintf 的版本 vsnprintf ， _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
輸出的大小 buffer 。 接受 char 的函式大小， 以及 接受 wchar_t 之函式的字組 大小。

count
要寫入的字元數上限，不包含終止 NULL 的 。 對於採用 wchar_t 的函式，這是要寫入的寬字元數。 或 _TRUNCATE 。

format
格式規格。

argptr
引數清單的指標。

locale
格式化輸出時要使用的地區設定。

如需詳細資訊，請參閱 格式規格 。

傳回值

寫入的字元數，不包括終止 NULL 的 ，如果發生輸出錯誤，則為負值。

如需詳細資訊，請參閱 行為摘要 。

備註

vsnprintf_s 與 _vsnprintf_s 相同，並包含在內，以符合 ANSI 標準。 _vnsprintf 保留以提供回溯相容性。

所有這些函式都會接受引數清單的指標，然後格式化指定的資料，並將其最多 count 個字元寫入 buffer 指向的記憶體，再附加終止的 Null。

這些有 _l 尾碼的函式版本是一樣的，不同之處在於會使用傳入的地區設定，而不使用目前的執行緒地區設定。

行為摘要

下表：

• 讓我們 len 成為格式化資料的大小。 如果函式接受 char 緩衝區，大小會以位元組為單位。 如果函式接受 wchar_t 緩衝區，大小會指定 16 位單字的數目。
• 字元是指 char 採用 char 緩衝區的函式字元，以及 wchar_t 採用 wchar_t 緩衝區之函式的字元。
• 如需無效參數處理常式的詳細資訊，請參閱 參數驗證 。

條件	行為	傳回值	errno	叫用無效的參數處理常式
成功	使用指定的格式字串將字元寫入緩衝區	寫入的字元數	N/A	No
格式設定期間的編碼錯誤	如果處理字串規範 s 、 S 或 Z ，格式規格處理會停止。	-1	EILSEQ (42)	No
格式設定期間的編碼錯誤	如果處理字元規範 c 或 C ，則會略過不正確字元。 寫入的字元數目不會針對略過的字元遞增，也不會為它寫入任何資料。 在略過規範並出現編碼錯誤之後，處理格式規格會繼續進行。	寫入的字元數，不包括終止 NULL 的 。	EILSEQ (42)	No
buffer == NULL和 和 sizeOfBuffer == 0count == 0	未寫入任何資料。	0	N/A	No
buffer == NULLsizeOfBuffer != 0和 或count != 0	如果在不正確參數處理常式執行之後繼續執行，請設定 errno 並傳回負值。	-1	EINVAL (22)	Yes
buffer != NULL 和 sizeOfBuffer == 0	未寫入任何資料。 如果在不正確參數處理常式執行之後繼續執行，請設定 errno 並傳回負值。	-1	EINVAL (22)	Yes
count == 0	不會寫入任何資料，並傳回已寫入的字元數，不包括終止 NULL 的 。	已寫入的字元數，不包含終止 NULL 的 。	N/A	No
count < 0	Unsafe：此值會被視為不帶正負號，因此可能會建立大型值，以覆寫緩衝區後面的記憶體。	寫入的字元數，不包括終止 NULL 的 。	N/A	No
count < sizeOfBuffer 和 len <= count	所有資料都會寫入，並附加終止 NULL 。	寫入的字元數。	N/A	No
count < sizeOfBuffer 和 len > count	會寫入第一 count 個字元。	-1	N/A	No
count >= sizeOfBuffer 和 len < sizeOfBuffer	所有資料都會以終止 NULL 來寫入。	寫入的字元數，不包括終止 NULL 的 。	N/A	No
count >= sizeOfBuffer和 和 len >= sizeOfBuffercount != _TRUNCATE	如果在不正確參數處理常式執行之後繼續執行，請設定 、設定 errnobuffer[0] == NULL ，並傳回負值。	-1	ERANGE (34)	Yes
count == _TRUNCATE 和 len >= sizeOfBuffer	寫入與 中 buffer 一樣多的字串，包括終止 NULL 。	-1	N/A	No
count == _TRUNCATE 和 len < sizeOfBuffer	使用終止 NULL 將整個字串寫入 。 buffer	寫入的字元數。	N/A	No
format == NULL	未寫入任何資料。 如果在不正確參數處理常式執行之後繼續執行，請設定 errno 並傳回負值。	-1	EINVAL (22)	Yes

如需這些錯誤碼和其他錯誤碼的相關資訊，請參閱 _doserrno 、 errno_sys_errlist 和 _sys_nerr 。

重要

確認 format 不是使用者定義的字串。 如需詳細資訊，請參閱 避免緩衝區滿溢 。 從 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.3500000000000000008）會繼續四捨五入至 2.4。 這些函式完成的四捨五入現在也會遵守 所 fesetround 設定的浮點舍入模式。 之前，舍入一律選擇 FE_TONEAREST 行為。 這項變更只會影響使用 Visual Studio 2019 16.2 版和更新版本所建置的程式。 若要使用舊版浮點舍入行為，請連結至 'legacy_stdio_float_rounding.obj' 。

注意

為確保障終止的 Null 有足夠空間，count 絕對要小於緩衝區長度，或使用 _TRUNCATE。

C++ 利用多載樣板簡化了這些函式的使用方式。多載可自動推斷緩衝區長度 (因而不須指定大小引數)，也可以將不安全的舊函式自動取代成較新且安全的對應函式。 如需詳細資訊，請參閱 保護範本多載 。

提示

如果您收到未定義的外部 _vsnprintf_s 錯誤並使用通用 C 執行時間，請將 新增 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