_snprintf_s、_snprintf_s_l、_snwprintf_s、_snwprintf_s_l_snprintf_s, _snprintf_s_l, _snwprintf_s, _snwprintf_s_l

文字列に書式付きデータを書き込みます。Writes formatted data to a string. これらは、「Security Features in the CRT」 (CRT のセキュリティ機能) の説明にあるとおり、セキュリティが強化されたバージョンの snprintf、_snprintf、_snprintf_l、_snwprintf、_snwprintf_l です。These are versions of snprintf, _snprintf, _snprintf_l, _snwprintf, _snwprintf_l with security enhancements as described in Security Features in the CRT.

構文Syntax

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

パラメーターParameters

バッファーbuffer
出力の格納場所。Storage location for the output.

sizeOfBuffersizeOfBuffer
出力の格納場所のサイズ。The size of the storage location for output. ( Snprintf_sの場合はバイト単位)、または単語単位のサイズ (_t)Size in bytes for _snprintf_s or size in words for _snwprintf_s.

countcount
格納する最大文字数、または _TRUNCATEMaximum number of characters to store, or _TRUNCATE.

formatformat
書式指定文字列。Format-control string.

argumentargument
省略可能な引数。Optional arguments.

localelocale
使用するロケール。The locale to use.

戻り値Return Value

snprintf_sは、バッファーに格納されている文字数を返します。終端の null 文字はカウントされません。_snprintf_s returns the number of characters stored in buffer, not counting the terminating null character. snwprintf_sは、バッファーに格納されているワイド文字の数を返します。終端の null ワイド文字はカウントされません。_snwprintf_s returns the number of wide characters stored in buffer, not counting the terminating null wide character.

データと終端の null を格納するために必要なストレージがsizeOfBufferを超えている場合は、「パラメーターの検証」で説明されているように、無効なパラメーターハンドラーが呼び出されます。If the storage required to store the data and a terminating null exceeds sizeOfBuffer, the invalid parameter handler is invoked, as described in Parameter Validation. 無効なパラメーターハンドラーの後に実行が継続する場合、これらの関数はbufferを空の文字列に設定し、 errnoERANGEに設定し、-1 を返します。If execution continues after the invalid parameter handler, these functions set buffer to an empty string, set errno to ERANGE, and return -1.

バッファーまたは形式NULLポインターの場合、またはcountが0以下の場合は、無効なパラメーターハンドラーが呼び出されます。If buffer or format is a NULL pointer, or if count is less than or equal to zero, the invalid parameter handler is invoked. 実行の継続が許可された場合、これらの関数はerrnoEINVALに設定し、-1 を返します。If execution is allowed to continue, these functions set errno to EINVAL and return -1.

エラー コードの詳細については、「_doserrno、errno、_sys_errlist、_sys_nerr」をご覧ください。For information about these and other error codes, see _doserrno, errno, _sys_errlist, and _sys_nerr.

RemarksRemarks

(_T) 関数は、カウントまたはバッファー内の文字数を書式設定して格納し、終端の null を追加します。The _snprintf_s function formats and stores count or fewer characters in buffer and appends a terminating null. 各引数 (存在する場合) は、対応する書式指定に従って変換および出力されます。Each argument (if any) is converted and output according to the corresponding format specification in format. 書式設定は、 printf関数ファミリと一致します。「書式指定構文: Printf 関数と Wprintf 関数」を参照してください。The formatting is consistent with the printf family of functions; see Format Specification Syntax: printf and wprintf Functions. 重なり合う文字列間でコピーした場合の動作は未定義です。If copying occurs between strings that overlap, the behavior is undefined.

CountTRUNCATEの場合は、終端の null を格納するために、バッファーに収まる限りの文字列がによって書き込まれます。If count is _TRUNCATE, then _snprintf_s writes as much of the string as will fit in buffer while leaving room for a terminating null. (終端の null を含む) 文字列全体がバッファーに格納されている場合は、(終端の null は含まない) 書き込まれた文字数が返されます。 それ以外の場合は、切り捨てが発生したことを示す-1を返しますIf the entire string (with terminating null) fits in buffer, then _snprintf_s returns the number of characters written (not including the terminating null); otherwise, _snprintf_s returns -1 to indicate that truncation occurred.

重要

format にユーザー定義の文字列を指定しないでください。Ensure that format is not a user-defined string.

snwprintf_sは、ワイド文字バージョンです。 (_t) ポインター引数 (snwprintf_s) はワイド文字列です。_snwprintf_s is a wide-character version of _snprintf_s; the pointer arguments to _snwprintf_s are wide-character strings. (Snwprintf_sでの) エンコードエラーの検出は、 snprintf_sでは異なる場合があります。Detection of encoding errors in _snwprintf_s might differ from that in _snprintf_s. swprintf_sのように、 snwprintf_sは、型ファイルの出力先ではなく文字列に出力を書き込みます。_snwprintf_s, like swprintf_s, writes output to a string rather than to a destination of type FILE.

_Lサフィックスを持つこれらの関数のバージョンは、現在のスレッドロケールの代わりに渡されたロケールパラメーターを使用する点を除いて同じです。The versions of these functions with the _l suffix are identical except that they use the locale parameter passed in instead of the current thread locale.

C++ では、これらの関数の使用はテンプレートのオーバーロードによって簡素化されます。オーバーロードでは、バッファー長を自動的に推論できる (サイズの引数を指定する必要がなくなる) だけでなく、古くてセキュリティが万全ではない関数を新しく安全な関数に自動的に置き換えることができます。In C++, using these functions is simplified by template overloads; the overloads can infer buffer length automatically (eliminating the need to specify a size argument) and they can automatically replace older, non-secure functions with their newer, secure counterparts. 詳細については、「 Secure Template Overloads」を参照してください。For more information, see Secure Template Overloads.

汎用テキスト ルーチンのマップGeneric-Text Routine Mappings

Tchar.h のルーチンTchar.h routine _UNICODE および _MBCS が未定義の場合_UNICODE and _MBCS not defined _MBCS が定義されている場合_MBCS defined _UNICODE が定義されている場合_UNICODE defined
sntprintf_s (_d)_sntprintf_s _snprintf_s_snprintf_s _snprintf_s_snprintf_s _snwprintf_s_snwprintf_s
_sntprintf_s_l_sntprintf_s_l _snprintf_s_l_snprintf_s_l _snprintf_s_l_snprintf_s_l _snwprintf_s_l_snwprintf_s_l

必要条件Requirements

ルーチンによって返される値Routine 必須ヘッダーRequired header
snprintf_s_snprintf_s_l_snprintf_s, _snprintf_s_l <stdio.h><stdio.h>
snwprintf_s_snwprintf_s_l_snwprintf_s, _snwprintf_s_l <stdio.h> または <wchar.h><stdio.h> or <wchar.h>

互換性の詳細については、「 互換性」を参照してください。For more compatibility information, see Compatibility.

Example

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

関連項目See also

ストリーム入出力Stream I/O
sprintf、_sprintf_l、swprintf、_swprintf_l、__swprintf_lsprintf, _sprintf_l, swprintf, _swprintf_l, __swprintf_l
fprintf、_fprintf_l、fwprintf、_fwprintf_lfprintf, _fprintf_l, fwprintf, _fwprintf_l
printf、_printf_l、wprintf、_wprintf_lprintf, _printf_l, wprintf, _wprintf_l
scanf、_scanf_l、wscanf、_wscanf_lscanf, _scanf_l, wscanf, _wscanf_l
sscanf、_sscanf_l、swscanf、_swscanf_lsscanf, _sscanf_l, swscanf, _swscanf_l
vprintf 系関数vprintf Functions