_snprintf_s
、 _snprintf_s_l
、 _snwprintf_s
、 _snwprintf_s_l
文字列に書式付きデータを書き込みます。 これらの関数は、CRT の 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
出力の格納場所のサイズ。 char
を受け取る関数のサイズはバイト単位、wchar_t
を使用する関数の場合はワード。
count
書き込む最大文字数。 wchar_t
を受け取る関数の場合、書き込むワイド文字の最大数です。 または、_TRUNCATE
です。
format
書式指定文字列。
argument
省略可能な引数。
locale
使用するロケール。
戻り値
終了 NULL
を含まない、書き込まれた文字数。 出力エラーが発生すると、負の値が返されます。 詳細については、 Behavior の概要 を参照してください。
解説
_snprintf_s
関数は、buffer
にcount
以下の文字を書式設定して格納し、終了NULL
を追加します。 各引数 (指定されている場合) は、format
内の対応する書式指定に応じて変換され、格納されます。 書式設定は、 printf
関数ファミリと一致します。 Format の仕様構文: printf
関数と wprintf
関数を参照してください。 重なり合う文字列間でコピーした場合の動作は未定義です。
動作の概要
次の表の場合:
- len
書式設定されたデータのサイズにします。 関数が char
バッファーを受け取る場合、サイズはバイト単位です。 関数が wchar_t
バッファーを受け取る場合、サイズは 16 ビットワードの数を指定します。
- 文字とは、
char
バッファーを受け取る関数のchar
文字と、wchar_t
バッファーを受け取る関数のwchar_t
文字を指します。 - 無効なパラメーター ハンドラーの詳細については、「 パラメーターの検証を参照してください。
条件 | Behavior | 戻り値 | errno |
無効なパラメーター ハンドラーを呼び出す |
---|---|---|---|---|
成功 | 指定した書式指定文字列を使用して、バッファーに文字を書き込みます。 | 終了 NULL を含まない、書き込まれた文字数。 |
該当なし | いいえ |
書式設定中のエンコード エラー | 文字列指定子 s 、 S 、または Z を処理すると、書式指定処理が停止します。 |
-1 | EILSEQ (42) |
いいえ |
書式設定中のエンコード エラー | 文字指定子の処理 c または C 場合、無効な文字はスキップされます。 書き込まれた文字数は、スキップされた文字に対してインクリメントされず、データも書き込まれません。 書式指定の処理は、エンコード エラーで指定子をスキップした後も続行されます。 |
終了 NULL を含まない、書き込まれた文字数。 |
EILSEQ (42) |
いいえ |
buffer == NULL 、sizeOfBuffer == 0 および count == 0 |
データは書き込みされません。 | 0 | 該当なし | いいえ |
buffer == NULL sizeOfBuffer != 0 またはcount != 0 |
無効なパラメーター ハンドラーの実行後も実行が続行される場合は、 errno を設定し、負の値を返します。 |
-1 | EINVAL (22) |
はい |
buffer != NULL および sizeOfBuffer == 0 |
データは書き込みされません。 | -1 | EINVAL (22) |
はい |
count == 0 |
NULL はバッファーの先頭に配置されます。 |
-1 | 該当なし | いいえ |
count < 0 |
Unsafe: 値は符号なしとして扱われ、バッファーに続くメモリが上書きされる大きな値が作成される可能性があります。 | 終了 NULL を含まない、書き込まれた文字数。 |
該当なし | いいえ |
count < sizeOfBuffer および len <= count |
すべてのデータが書き込まれ、終了 NULL が追加されます。 |
書き込まれる文字数です。 | 該当なし | いいえ |
count < sizeOfBuffer および len > count |
最初の count 文字が書き込まれ、終了 NULL が追加されます。 |
-1 | 該当なし | いいえ |
count >= sizeOfBuffer および len < sizeOfBuffer |
すべてのデータは、終了 NULL で書き込まれます。 |
書き込まれる文字数です。 | 該当なし | いいえ |
count >= sizeOfBuffer 、len >= sizeOfBuffer および count != _TRUNCATE |
無効なパラメーター ハンドラーの実行後も実行が続行される場合は、 errno を設定し、 buffer[0] == NULL を設定して、負の値を返します。 |
-1 | ERANGE (34) |
はい |
count == _TRUNCATE および len >= sizeOfBuffer |
buffer と終了NULL に収まる限り多くの文字列を書き込みます。 |
-1 | 該当なし | いいえ |
count == _TRUNCATE および len < sizeOfBuffer |
終了NULL を使用して、文字列全体をbuffer に書き込みます。 |
終了 NULL を含まない、書き込まれた文字数。 |
該当なし | いいえ |
format == NULL |
データは書き込みされません。 無効なパラメーター ハンドラーの実行後も実行が続行される場合は、 errno を設定し、負の値を返します。 |
-1 | EINVAL (22) |
はい |
これらのエラー コードおよびその他のエラー コードの詳細については、「_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.35000000000000008 に近い) は、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
では、エンコーディング エラーの検出動作が異なる場合があります。 swprintf_s
と同様に、_snwprintf_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> |
互換性の詳細については、「 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: ''
関連項目
ストリーム入出力
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
関数