使用指向參數清單的指標寫入格式化輸出。 這些函數是 、 vsnprintf_vsnprintf_vsnprintf_l的版本_vsnwprintf,_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
for 輸出的大小 buffer 。 採用的函數的大小(以位元組為單位),採用的函數的char字的大小(以wchar_t為單位)。
count
要寫入的最大字元數,不包括終止字元 NULL。 對於採用的 wchar_t函數,它是要寫入的寬字元數。 或 _TRUNCATE。
format
格式規範。
argptr
指向參數清單的指標。
locale
格式化輸出時要使用的區域設置。
有關更多資訊,請參閱 格式規範。
返回值
寫入的字元數,不包括 terminating NULL,如果發生輸出錯誤,則不包括負值。
如需詳細資訊,請參閱 行為摘要 。
備註
這些函數中的每一個都採用指向參數清單的指標,然後將給定數據的字元格式化並寫入 count 指向的 buffer 記憶體,並附加一個終止 NULL.
在調試版本中,終止sizeOfBuffer后的剩餘NULL位元組用「xFE」填充,如 _CrtSetDebugFillThreshold中所述。
這些帶有 _l 後綴的函數的版本是相同的,只是它們使用傳入的locale參數,而不是當前線程區域設置。
vsnprintf_s 與 ANSI 標準相同 _vsnprintf_s ,並且為了符合 ANSI 標準而包含在內。
_vnsprintf 保留以實現向後相容性。
行為摘要
下表:
- 讓我們
len成為格式化數據的大小。 如果函式接受char緩衝區,大小會以位元組為單位。 如果函式接受wchar_t緩衝區,大小會指定16位單字的數目。 - 字元是指
char採用char緩衝區的函式字元,以及wchar_t採用wchar_t緩衝區之函式的字元。 - 如需無效參數處理程式的詳細資訊,請參閱 參數驗證。
| 狀況 | 行為 | 返回值 | errno |
叫用無效的參數處理常式 |
|---|---|---|---|---|
| 成功 | 使用指定的格式字串將字元寫入緩衝區 | 寫入的字元數 | N/A | 否 |
| 格式設定期間的編碼錯誤 | 如果處理字串說明符 s、 S、 或 Z格式規範處理將停止。 |
-1 | EILSEQ (42) |
否 |
| 格式設定期間的編碼錯誤 | 如果處理字元規範 c 或 C,則會略過無效的字元。 寫入的字元數目不會針對略過的字元遞增,也不會為它寫入任何數據。 在略過規範並出現編碼錯誤之後,處理格式規格會繼續進行。 |
寫入的字元數,不包括終止 NULL的 。 |
EILSEQ (42) |
否 |
buffer == NULL以及sizeOfBuffer == 0count == 0 |
未寫入任何數據。 | 0 | N/A | 否 |
buffer == NULL和或sizeOfBuffer != 0count != 0 |
如果在無效的參數處理程式執行之後繼續執行,請設定 errno 並傳回負值。 |
-1 |
EINVAL (22) |
是的 |
buffer != NULL 和 sizeOfBuffer == 0 |
未寫入任何數據。 如果在無效的參數處理程式執行之後繼續執行,請設定 errno 並傳回負值。 |
-1 |
EINVAL (22) |
是的 |
buffer != NULL以及sizeOfBuffer != 0count == 0 |
緩衝區終止 NULL 。 |
-1 | N/A | 否 |
count == 0 |
不寫入任何數據,並返回本應寫入的字元數,不包括終止 NULL. |
本應寫入的字元數,不包括終止 NULL. |
N/A | 否 |
count < 0 |
Unsafe:此值會被視為不帶正負號,因此可能會建立大型值,以覆寫緩衝區後面的記憶體。 | 寫入的字元數,不包括終止 NULL的 。 |
N/A | 否 |
count < sizeOfBuffer 和 len <= count |
所有數據都會寫入,並附加終止 NULL 。 |
寫入的字元數。 | N/A | 否 |
count < sizeOfBuffer 和 len > count |
將寫入第一個 count 字元。 |
-1 | N/A | 否 |
count >= sizeOfBuffer 和 len < sizeOfBuffer |
所有數據都會以終止 NULL來寫入。 |
寫入的字元數,不包括終止 NULL的 。 |
N/A | 否 |
count >= sizeOfBuffer以及len >= sizeOfBuffercount != _TRUNCATE |
如果在無效參數處理程式執行後繼續執行,則 sets errno、 sets buffer[0] == NULL並返回負值。 |
-1 |
ERANGE (34) |
是的 |
count == _TRUNCATE 和 len >= sizeOfBuffer |
寫入 中適合 buffer的字串,包括終止 NULL. |
-1 | N/A | 否 |
count == _TRUNCATE 和 len < sizeOfBuffer |
使用 terminating buffer將整個字串NULL寫入 。 |
寫入的字元數。 | N/A | 否 |
format == NULL |
未寫入任何數據。 如果在無效的參數處理程式執行之後繼續執行,請設定 errno 並傳回負值。 |
-1 |
EINVAL (22) |
是的 |
如需這些錯誤碼和其他錯誤碼的相關信息,請參閱_doserrno、 errno_sys_errlist和 _sys_nerr。
這很重要
確認 format 不是使用者定義的字串。 如需詳細資訊,請參閱 Avoiding Buffer Overruns (避免緩衝區滿溢)。
從 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連結。
備註
要確保有空間用於 termination NULL,請確保 嚴格 count 小於緩衝區長度,或使用 _TRUNCATE。
在 C++ 中,範本重載簡化了這些函數的使用;重載可以自動推斷緩衝區長度(無需指定 size 參數),並且可以自動將較舊的非安全函數替換為更新的安全函數。 如需詳細資訊,請參閱安全範本多載。
小提示
如果您收到未定義的外部 _vsnprintf_s 錯誤,並且正在使用 Universal C Runtime,請添加到 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_endva_start