strcat_s、wcscat_s、_mbscat_s

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

更新 : 2007 年 11 月

文字列を追加します。これらの関数は、「CRT のセキュリティ強化」に説明されているように、strcat、wcscat、_mbscat のセキュリティが強化されたバージョンです。

errno_t strcat_s(
   char *strDestination,
   size_t numberOfElements,
   const char *strSource 
);
errno_t wcscat_s(
   wchar_t *strDestination,
   size_t numberOfElements,
   const wchar_t *strSource 
);
errno_t _mbscat_s(
   unsigned char *strDestination,
   size_t numberOfElements,
   const unsigned char *strSource 
);
template <size_t size>
errno_t strcat_s(
   char (&strDestination)[size],
   const char *strSource 
); // C++ only
template <size_t size>
errno_t wcscat_s(
   wchar_t (&strDestination)[size],
   const wchar_t *strSource 
); // C++ only
template <size_t size>
errno_t _mbscat_s(
   unsigned char (&strDestination)[size],
   const unsigned char *strSource 
); // C++ only

パラメータ

strDestination
null で終わる追加先の文字列バッファ。
numberOfElements
追加先の文字列バッファのサイズ。
strSource
null で終わる元の文字列バッファ。

戻り値

正常終了した場合は 0 を返します。失敗した場合はエラーコードを返します。

エラー条件

strDestination	numberOfElements	strSource	戻り値	strDestination の内容
NULL または未終了	any	any	EINVAL	変更されない
any	any	NULL	EINVAL	strDestination[0] が 0 に設定される
any	0 または小さすぎる	any	ERANGE	strDestination[0] が 0 に設定される

解説

strcat_s 関数は、strSource を strDestination に追加し、結果の文字列の終端に null 文字を付けます。strSource の先頭の文字は、strDestination の終端の null 文字を上書きします。コピー元とコピー先の文字列が重なり合っている場合の strcat_s 関数の動作は未定義です。

2 つ目のパラメータは、バッファの残りのサイズではなく、合計サイズであることに注意してください。

char buf[16];
strcpy_s(buf, 16, "Start");
strcat_s(buf, 16, " End");               // Correct
strcat_s(buf, 16 – strlen(buf), " End"); // Incorrect

wcscat_s 関数と _mbscat_s 関数は、strcat_s 関数のワイド文字バージョンとマルチバイト文字バージョンです。wcscat_s 関数の引数と戻り値はワイド文字列で、_mbscat_s 関数の引数と戻り値はマルチバイト文字列です。それ以外では、これらの関数の動作は同じです。

strDestination が null ポインタであるか null で終わらない場合、または strSource が NULL ポインタであるか、コピー先文字列が小さすぎる場合、「パラメータの検証」で説明されているように、無効なパラメータハンドラが起動します。実行の継続が許可された場合、これらの関数は EINVAL を返し、errno を EINVAL に設定します。

C++ では、これらの関数の使用はテンプレートのオーバーロードによって簡素化されます。オーバーロードでは、バッファ長を自動的に推論できる (サイズの引数を指定する必要がなくなる) だけでなく、古くてセキュリティが万全ではない関数を新しく安全な関数に自動的に置き換えることができます。詳細については、「セキュリティ保護されたテンプレートオーバーロード」を参照してください。

これらの関数のデバッグバージョンは、最初にバッファを 0xFD で埋めます。この動作を無効にするには、_CrtSetDebugFillThreshold を使用します。

汎用テキストルーチンのマップ