sprintf、 _sprintf_l, swprintf, _swprintf, _swprintf_l__swprintf_l

  • [アーティクル]

文字列に書式付きデータを書き込みます。 これらの関数のセキュリティを強化したバージョンについては、「sprintf_s、_sprintf_s_l、swprintf_s、_swprintf_s_l」を参照してください。 セキュリティ保護されたバージョンの swprintf と _swprintf_l は、バッファーのサイズをパラメーターとして受け取ります。

構文

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(
   wchar_t *buffer,
   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

パラメーター

buffer
出力の格納場所。

count
この関数の Unicode バージョンで格納する最大文字数。

format
書式指定文字列。

argument
省略可能な引数。

locale
使用するロケール。

詳細については、「書式指定構文」を参照してください。

戻り値

書き込まれた文字数を返します。エラーが発生した場合は -1 を返します。 null ポインターのformat場合bufferは、「パラメーターの検証」で説明されているように、無効なパラメーター ハンドラーが呼び出されます。 実行の継続が許可された場合、これらの関数は -1 を返し、errno を EINVAL に設定します。

sprintf 関数は、 bufferに格納されているバイト数を返します。終端の null 文字は含まれません。 swprintf は、buffer に格納されているワイド文字数を返します。終端の null ワイド文字は含まれません。

解説

sprintf 関数は、一連の文字と値の書式を指定して、 bufferに格納します。 各 argument (指定されている場合) は、 format中の対応する書式指定に応じて変換され、格納されます。 書式は通常の文字で構成され、その形式と機能は printf の format 引数と同じです。 最後に書き込まれる文字の後に NULL 文字が追加されます。 重なり合う文字列間でコピーした場合の動作は未定義です。

重要

sprintf 関数を使用する際、書き込まれる文字数は制限できないため、sprintf 関数を使用しているコードでは、バッファー オーバーランが発生しやすくなります。 関連する関数である snprintf の使用を検討してください。この関数では、buffer に書き込む最大文字数を指定できます。_scprintf を使用すると、必要なバッファーのサイズを調べることができます。 また、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.35000000000000008 に近い) は、2.4 に切り上げられます。 これらの関数によって実行される丸め処理では、fesetround によって設定された浮動小数点丸めモードにも従うようになりました。 以前は、丸め処理には常に FE_TONEAREST の動作が選択されていました。 この変更は、Visual Studio 2019 バージョン 16.2 以降を使用してビルドされたプログラムにのみ影響します。 従来の浮動小数点丸め動作を使用するには、'legacy_stdio_float_rounding.obj' にリンクします。

swprintf は sprintfのワイド文字バージョンであり、 swprintf のポインター引数はワイド文字列です。 swprintf と sprintf では、エンコーディング エラーの検出動作が異なる場合があります。 swprintfと同じように動作しますfwprintfが、型FILEの宛先ではなく文字列に出力を書き込む場合を除きswprintf、swprintfパラメーターは書き込む最大文字数を指定する必要countがあります。 これらの関数のうち _l サフィックスが付けられたバージョンは、現在のスレッド ロケールの代わりに渡されたロケール パラメーターを使用する点を除いて同じです。

署名 swprintf が標準化される前のバージョンは、文字カウント パラメーターを受け取らなかった古い Microsoft C ランタイム ライブラリに付属していました。 以前のバージョンは引き続き Microsoft C ランタイム ライブラリで使用できますが、非推奨となり、名前が変更されました _swprintf()。 古いシグネチャに対して記述されたコードの場合は、呼び出しを次にswprintf_swprintfマップする define を定義_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_swprintf_l <stdio.h> または <wchar.h>

互換性の詳細については、「 Compatibility」を参照してください。

例: sprintf を使用してデータの書式を設定する

// 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 );
}

Output:
   String:    computer
   Character: l
   Integer:   35
   Real:      1.732053

character count = 79

例: エラー コードの処理

// 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 );
}

wrote 11 characters
wrote -1 characters

関連項目

ストリーム入出力
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 関数