_snprintf_s、_snprintf_s_l、_snwprintf_s、_snwprintf_s_l

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

文字列に書式付きデータを書き込みます。これらの関数は、「CRT のセキュリティ強化」に説明されているように、_snprintf、_snprintf_l、_snwprintf、_snwprintf_l のセキュリティが強化されたバージョンです。

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
出力の格納場所のサイズ。_snprintf_s の場合はbytes単位のサイズ、_snwprintf_s の場合はwords単位のサイズ。
Count
格納する最大文字数、または_TRUNCATE。
format
書式指定文字列。
argument
省略可能な引数。
locale
使用するロケール。

戻り値

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

データと終端の null の格納に必要なストレージが sizeOfBuffer を超える場合は、「パラメータの検証」に説明されているように、無効なパラメータハンドラが呼び出されます。無効なパラメータハンドラの後に実行が継続されると、これらの関数は buffer を空の文字列に、errno を ERANGE に設定し、-1 を返します。

buffer または format が NULL ポインタの場合、または count が 0 以下の場合は、無効なパラメータハンドラが呼び出されます。実行の継続が許可された場合、これらの関数は errno を EINVAL に設定し、-1 を返します。

エラーコードの詳細については、「_doserrno、errno、_sys_errlist、および _sys_nerr」を参照してください。

解説

_snprintf_s 関数は、count の文字数以下の文字を書式指定して buffer に格納し、終端の null を追加します。各引数 (指定されている場合) は、format 中の対応する書式指定に応じて変換され、格納されます。この書式指定は、printf 系関数と一貫性があります。「printf 関数と wprintf 関数の書式指定フィールド」を参照してください。重なり合う文字列間でコピーした場合の動作は未定義です。

count が _TRUNCATE の場合、_snprintf_s 関数は終端の null 用の空きを残して buffer に収まる限りの文字列を書き込みます。文字列全体 (終端の null を含む) が buffer 内に収まる場合は、_snprintf_s 関数は書き込まれた文字数を返します (終端の null は含まない)。それ以外の場合、_snprintf_s 関数は -1 を返し、切り捨てが行われたことを示します。

セキュリティに関するメモ :
format にユーザー定義の文字列を指定しないでください。

_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>

互換性の詳細については、「C ランタイムライブラリ」の「互換性」を参照してください。

使用例

// 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, int count )
{
   char dest[10];

   printf( "\n" );

   if ( count == _TRUNCATE )
      printf( "%d-byte buffer; truncation semantics\n",
               _countof(dest) );
   else
      printf( "count = %d; %d-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: ''