建議使用 Visual Studio 2017

_snprintf_s、_snprintf_s_l、_snwprintf_s、_snwprintf_s_l

 

如需 Visual Studio 2017 的最新文件請參閱 Visual Studio 2017 文件

將格式化資料寫入字串。 這些是舊版snprintf,_snprintf、 _snprintf_l、 _snwprintf、 _snwprintf_l中所述的安全性增強CRT 中的安全性功能

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
輸出的儲存位置的大小。 調整大小bytes_snprintf_s或大小words_snwprintf_s

Count
要儲存的字元數目上限或_TRUNCATE

format
格式控制字串。

argument
選擇性引數。

locale
要使用的地區設定。

_snprintf_s傳回儲存在中的字元數buffer,不計結束的 null 字元。 _snwprintf_s 會傳回儲存在 buffer 中的寬字元數目,不計結束的 null 寬字元。

如果儲存資料和結束的 null 所需的儲存體超過sizeOfBuffer、 無效參數處理常式叫用時,所述參數驗證。 如果不正確的參數處理常式之後繼續執行,這些函式會將buffer為空字串,設定errnoERANGE,並傳回-1。

如果bufferformatNULL指標,或如果count小於或等於零,會叫用無效參數處理常式。 如果允許繼續執行,這些函式會將 errno 設定為 EINVAL ,並傳回 -1。

如需這些和其他錯誤碼的資訊,請參閱_doserrno,errno,_sys_errlist 和 _sys_nerr

_snprintf_s函式的格式化並儲存count或較少的字元buffer,並將結束的 null。 每個引數 (如果有的話) 會轉換和輸出中的對應格式規格根據format。 格式都是一致的printf系列的函式; 請參閱格式規格語法︰ printf 和 wprintf 函式。 如果在重疊的字串之間進行複製,則行為是未定義的。

如果count_TRUNCATE,然後_snprintf_s盡量將字串寫入以致於無法納入buffer時留出空間給結束的 null。 如果整個字串 (含結束 null) 納入buffer,然後_snprintf_s傳回寫入字元數目 (不包括結束的 null); 否則_snprintf_s會傳回 – 1,表示該截斷發生。

System_CAPS_ICON_important.jpg 重要

確認 format 不是使用者定義的字串。

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

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

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

一般文字常式對應

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>

如需更多的相容性資訊,請參閱<簡介>中的 Compatibility

// 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: ''  

不適用。 若要呼叫標準 C 函式,請使用 PInvoke。 如需詳細資訊,請參閱 平台叫用範例

資料流 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 函式

顯示: