sprintf、_sprintf_l、swprintf、_swprintf_l、__swprintf_l

發行項
07/21/2015

將格式化資料寫入字串。其中部分函式的可用安全版本，請參閱 sprintf_s、_sprintf_s_l、swprintf_s、_swprintf_s_l。 swprintf 和 _swprintf_l 的安全版本不接受 count 參數。

int sprintf(
   char *buffer,
   const char *format [,
   argument] ... 
);
int _sprintf_l(
   char *buffer,
   const char *format,
   locale_t locale [,
   argument] ... 
);
int swprintf(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format [,
   argument]...
);
int _swprintf_l(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   locale_t locale [,
   argument] ... 
);
int __swprintf_l(
   wchar_t *buffer,
   const wchar_t *format,
   locale_t locale [,
   argument] ... 
);
template <size_t size>
int sprintf(
   char (&buffer)[size],
   const char *format [,
   argument] ... 
); // C++ only
template <size_t size>
int _sprintf_l(
   char (&buffer)[size],
   const char *format,
   locale_t locale [,
   argument] ... 
); // C++ only
template <size_t size>
int swprintf(
   wchar_t (&buffer)[size],
   const wchar_t *format [,
   argument]...
); // C++ only
template <size_t size>
int _swprintf_l(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   locale_t locale [,
   argument] ... 
); // C++ only

參數

buffer
輸出的儲存位置
count
在此函式 Unicode 版本中儲存的最大字元數。
format
格式控制字串
argument
選擇性引數
locale
使用的地區設定。

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

傳回值

寫入的字元數目，如果發生錯誤則為 -1。如果 buffer 或 format 為 null 指標，則叫用無效參數處理常式，如參數驗證中所述。如果允許繼續執行，這些函式會傳回 -1 並將errno 設定為 EINVAL。

sprintf 會傳回儲存在 buffer中的位元組數目，不計算結束的 null 字元。 swprintf會傳回 buffer 中儲存的寬字元數目，不計算結束的 null 寬字元。

備註

sprintf 函式會在 buffer 中格式化並儲存一連串字元和值。每個 argument (如果有的話) 是根據 format中的對應格式規格轉換和輸出。此格式包含一般字元，與 printf 的 format 引數具有相同的形式和功能。 Null 字元會附加至最後一個寫入的字元後。如果在重疊的字串之間執行複製，則行為是未定義的。

安全性提示
使用 sprintf 時，無法限制寫入的字元數目，這表示使用 sprintf 的程式碼很容易發生緩衝區滿溢。考慮使用相關函式 _snprintf，指定要寫入至 buffer 的字元數目上限，或使用 _scprintf 來判斷需要多大的緩衝區。此外，還要確保 format 不是使用者定義的字串。

swprintf 是 sprintf 的寬字元版本，swprintf 的指標引數是寬字元字串。 swprintf 的程式碼錯誤偵測可能不同於 sprintf。 swprintf 和 fwprintf 的作用完全相同，例外的是，swprintf 會將輸出寫入字串而非類型為 FILE 的目的端，而且 swprintf 必須有 count參數才能指定要寫入的字元數上限。尾碼為 _l 的這些函式版本是一樣的，只不過它們使用傳入的地區設定，而不是目前執行緒的地區設定。

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

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

一般文字常式對應

TCHAR.H 常式	未定義 _UNICODE & _MBCS	已定義 _MBCS	已定義 _UNICODE
_stprintf	sprintf	sprintf	swprintf
_stprintf_l	_sprintf_l	_sprintf_l	__swprintf_l

需求

常式	必要的標頭
sprintf, _sprintf_l	<stdio.h>
swprintf, _swprintf_l	<stdio.h> 或 <wchar.h>

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

範例

// crt_sprintf.c
// compile with: /W3
// This program uses sprintf to format various
// data and place them in the string named buffer.

#include <stdio.h>

int main( void )
{
   char  buffer[200], s[] = "computer", c = 'l';
   int   i = 35, j;
   float fp = 1.7320534f;

   // Format and print various data: 
   j  = sprintf( buffer,     "   String:    %s\n", s ); // C4996
   j += sprintf( buffer + j, "   Character: %c\n", c ); // C4996
   j += sprintf( buffer + j, "   Integer:   %d\n", i ); // C4996
   j += sprintf( buffer + j, "   Real:      %f\n", fp );// C4996
   // Note: sprintf is deprecated; consider using sprintf_s instead

   printf( "Output:\n%s\ncharacter count = %d\n", buffer, j );
}

// crt_swprintf.c
// wide character example
// also demonstrates swprintf returning error code
#include <stdio.h>

int main( void )
{
   wchar_t buf[100];
   int len = swprintf( buf, 100, L"%s", L"Hello world" );
   printf( "wrote %d characters\n", len );
   len = swprintf( buf, 100, L"%s", L"Hello\xffff world" );
   // swprintf fails because string contains WEOF (\xffff)
   printf( "wrote %d characters\n", len );
}