Share via

_snprintf_s, _snprintf_s_l, _snwprintf_s, _snwprintf_s_l

  • 發行項

將格式化資料寫入字串。 這些函式是 、、 、、， _snwprintf_l 以及 CRT 中安全性功能中所述 的安全性增強功能。 _snwprintf_snprintf_l_snprintfsnprintf

語法

int _snprintf_s(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format [,
   argument] ...
);

int _snprintf_s_l(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format,
   _locale_t locale [,
   argument] ...
);

int _snwprintf_s(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format [,
   argument] ...
);

int _snwprintf_s_l(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format,
   _locale_t locale [,
   argument] ...
);

template <size_t size>
int _snprintf_s(
   char (&buffer)[size],
   size_t count,
   const char *format [,
   argument] ...
); // C++ only

template <size_t size>
int _snwprintf_s(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format [,
   argument] ...
); // C++ only

參數

buffer
輸出的儲存位置。

sizeOfBuffer
輸出的儲存位置大小。 接受 char 的函式大小， 以及 接受 wchar_t 之函式的字組 大小。

count
要寫入的最大字元數。 對於採用 wchar_t 的函式，這是要寫入的最大寬字元數。 或 _TRUNCATE 。

format
格式控制字串。

argument
選擇性引數。

locale
要使用的地區設定。

傳回值

寫入的字元數，不包括終止 NULL 的 。 如果發生輸出錯誤，則會傳回負值。 如需詳細資訊，請參閱 行為摘要 。

備註

函式會在 _snprintf_scount 中 buffer 格式化和儲存或減少字元，並附加終止 NULL 的 。 每個引數 (如果有的話) 都是根據 format 中的對應格式規格進行轉換和輸出。 格式設定與 printf 函式系列一致;請參閱 格式規格語法： printf 和 wprintf 函式 。 如果在重疊的字串之間進行複製，則行為是未定義的。

行為摘要

下表：

-Let len be the size of the formatted data. 如果函式接受 char 緩衝區，大小會以位元組為單位。 如果函式接受 wchar_t 緩衝區，大小會指定 16 位單字的數目。

  • 字元是指 char 採用 char 緩衝區的函式字元，以及 wchar_t 採用 wchar_t 緩衝區之函式的字元。
  • 如需無效參數處理常式的詳細資訊，請參閱 參數驗證 。
Condition 行為 傳回值 errno 叫用無效的參數處理常式
成功 使用指定的格式字串，將字元寫入緩衝區。 寫入的字元數，不包括終止 NULL 的 。 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 未寫入任何資料。 -1 EINVAL (22) Yes
count == 0 NULL會放在緩衝區的開頭。 -1 N/A No
count < 0 Unsafe：此值會被視為不帶正負號，因此可能會建立大型值，以覆寫緩衝區後面的記憶體。 寫入的字元數，不包括終止 NULL 的 。 N/A No
count < sizeOfBuffer 和 len <= count 所有資料都會寫入，並附加終止 NULL 。 寫入的字元數。 N/A No
count < sizeOfBuffer 和 len > count 會寫入第一 count 個字元，並附加終止 NULL 。 -1 N/A No
count >= sizeOfBuffer 和 len < sizeOfBuffer 所有資料都會以終止 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 寫入的字元數，不包括終止 NULL 的 。 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' 。

_snwprintf_s 是 _snprintf_s的寬字元版本， _snwprintf_s 的指標引數是寬字元字串。 _snwprintf_s 中的編碼錯誤偵測可能不同於 _snprintf_s。 _snwprintf_s 與 swprintf_s 類似，會將輸出寫入字串，而不是 FILE 類型的目的地。

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

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

泛型文字常式對應

Tchar.h 常規 _UNICODE 和 _MBCS 未定義 _MBCS 定義 _UNICODE 定義
_sntprintf_s _snprintf_s _snprintf_s _snwprintf_s
_sntprintf_s_l _snprintf_s_l _snprintf_s_l _snwprintf_s_l

需求

常式 必要的標頭
_snprintf_s, _snprintf_s_l <stdio.h>
_snwprintf_s, _snwprintf_s_l <stdio.h> 或 <wchar.h>

如需相容性詳細資訊，請參閱相容性。

範例

// crt_snprintf_s.cpp
// compile with: /MTd

// These #defines enable secure template overloads
// (see last part of Examples() below)
#define _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES 1
#define _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES_COUNT 1

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <crtdbg.h>  // For _CrtSetReportMode
#include <errno.h>

// This example uses a 10-byte destination buffer.

int snprintf_s_tester( const char * fmt, int x, size_t count )
{
   char dest[10];

   printf( "\n" );

   if ( count == _TRUNCATE )
      printf( "%zd-byte buffer; truncation semantics\n",
               _countof(dest) );
   else
      printf( "count = %zd; %zd-byte buffer\n",
               count, _countof(dest) );

   int ret = _snprintf_s( dest, _countof(dest), count, fmt, x );

   printf( "    new contents of dest: '%s'\n", dest );

   return ret;
}

void Examples()
{
   // formatted output string is 9 characters long: "<<<123>>>"
   snprintf_s_tester( "<<<%d>>>", 121, 8 );
   snprintf_s_tester( "<<<%d>>>", 121, 9 );
   snprintf_s_tester( "<<<%d>>>", 121, 10 );

   printf( "\nDestination buffer too small:\n" );

   snprintf_s_tester( "<<<%d>>>", 1221, 10 );

   printf( "\nTruncation examples:\n" );

   int ret = snprintf_s_tester( "<<<%d>>>", 1221, _TRUNCATE );
   printf( "    truncation %s occur\n", ret == -1 ? "did"
                                                  : "did not" );

   ret = snprintf_s_tester( "<<<%d>>>", 121, _TRUNCATE );
   printf( "    truncation %s occur\n", ret == -1 ? "did"
                                                  : "did not" );
   printf( "\nSecure template overload example:\n" );

   char dest[10];
   _snprintf( dest, 10, "<<<%d>>>", 12321 );
   // With secure template overloads enabled (see #defines
   // at top of file), the preceding line is replaced by
   //    _snprintf_s( dest, _countof(dest), 10, "<<<%d>>>", 12345 );
   // Instead of causing a buffer overrun, _snprintf_s invokes
   // the invalid parameter handler.
   // If secure template overloads were disabled, _snprintf would
   // write 10 characters and overrun the dest buffer.
   printf( "    new contents of dest: '%s'\n", dest );
}

void myInvalidParameterHandler(
   const wchar_t* expression,
   const wchar_t* function,
   const wchar_t* file,
   unsigned int line,
   uintptr_t pReserved)
{
   wprintf(L"Invalid parameter handler invoked: %s\n", expression);
}

int main( void )
{
   _invalid_parameter_handler oldHandler, newHandler;

   newHandler = myInvalidParameterHandler;
   oldHandler = _set_invalid_parameter_handler(newHandler);
   // Disable the message box for assertions.
   _CrtSetReportMode(_CRT_ASSERT, 0);

   Examples();
}


count = 8; 10-byte buffer
    new contents of dest: '<<<121>>'

count = 9; 10-byte buffer
    new contents of dest: '<<<121>>>'

count = 10; 10-byte buffer
    new contents of dest: '<<<121>>>'

Destination buffer too small:

count = 10; 10-byte buffer
Invalid parameter handler invoked: ("Buffer too small", 0)
    new contents of dest: ''

Truncation examples:

10-byte buffer; truncation semantics
    new contents of dest: '<<<1221>>'
    truncation did occur

10-byte buffer; truncation semantics
    new contents of dest: '<<<121>>>'
    truncation did not occur

Secure template overload example:
Invalid parameter handler invoked: ("Buffer too small", 0)
    new contents of dest: ''

另請參閱

資料流 I/O
sprintf, _sprintf_l, swprintf, _swprintf_l, __swprintf_l
fprintf, _fprintf_l, fwprintf, _fwprintf_l
printf, _printf_l, wprintf, _wprintf_l
scanf, _scanf_l, wscanf, _wscanf_l
sscanf, _sscanf_l, swscanf, _swscanf_l
vprintf 函數