strncat、_strncat_l、wcsncat、wcsncat_l、_mbsncat、_mbsncat_l

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

更新 : 2007 年 11 月

文字列に文字を追加します。これらの関数のセキュリティを強化したバージョンについては、「strncat_s、_strncat_s_l、wcsncat_s、_wcsncat_s_l、_mbsncat_s、_mbsncat_s_l」を参照してください。

char *strncat(
   char *strDest,
   const char *strSource,
   size_t count 
);
wchar_t *wcsncat(
   wchar_t *strDest,
   const wchar_t *strSource,
   size_t count 
);
unsigned char *_mbsncat(
   unsigned char *strDest,
   const unsigned char *strSource,
   size_t count
);
unsigned char *_mbsncat_l(
   unsigned char *strDest,
   const unsigned char *strSource,
   size_t count,
   _locale_t locale
);
template <size_t size>
char *strncat(
   char (&strDest)[size],
   const char *strSource,
   size_t count 
); // C++ only
template <size_t size>
wchar_t *wcsncat(
   wchar_t (&strDest)[size],
   const wchar_t *strSource,
   size_t count 
); // C++ only
template <size_t size>
unsigned char *_mbsncat(
   unsigned char (&strDest)[size],
   const unsigned char *strSource,
   size_t count
); // C++ only
template <size_t size>
unsigned char *_mbsncat_l(
   unsigned char (&strDest)[size],
   const unsigned char *strSource,
   size_t count,
   _locale_t locale
); // C++ only

パラメータ

strDest
NULL で終わる追加先の文字列。
strSource
NULL で終わる元の文字列。
count
追加する文字数。
locale
使用するロケール。

戻り値

追加先文字列へのポインタを返します。エラーを示す戻り値は予約されていません。

解説

strncat 関数は、strSource の最初の count の文字数までを strDest に追加します。strSource の先頭の文字は、strDest の終端の null 文字を上書きします。count の文字数が追加される前に strSource に null 文字があった場合、strncat は、strSource の null 文字までのすべての文字を追加します。count が strSource の長さを超えると、strSource の長さが count の代わりに使用されます。結果の文字列はすべて、null 文字で終了します。重なり合う文字列間でコピーした場合の動作は未定義です。

セキュリティに関するメモ :
strncat は strDest に十分な領域があるかどうかを確認しないため、バッファオーバーランが発生する可能性があります。count は、追加される文字数を制限しますが、strDest のサイズは制限しません。下記の例を参照してください。詳細については、「Avoiding Buffer Overruns」を参照してください。

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

出力値は、ロケールの LC_CTYPE カテゴリの設定で決まります。詳細については、「setlocale」を参照してください。_l サフィックスが付いていないこの関数のバージョンでは、このロケールに依存する動作に現在のロケールを使用します。_l サフィックスが付いているバージョンは、渡されたロケールパラメータを代わりに使用する点を除いて同じです。詳細については、「ロケール」を参照してください。

C++ では、これらの関数にテンプレートのオーバーロードがあります。詳細については、「セキュリティ保護されたテンプレートオーバーロード」を参照してください。

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcsncat	strncat	_mbsnbcat	wcsncat
_tcsncat_l	_strncat_l	_mbsnbcat_l	_wcsncat_l

メモ :
_strncat_l と _wcsncat_l は、ロケールに依存していません。また、直接呼び出されることはありません。これらの変数は _tcsncat_l で内部的に使用されます。

必要条件

ルーチン	必須ヘッダー
strncat	<string.h>
wcsncat	<string.h> または <wchar.h>
_mbsncat	<mbstring.h>
_mbsncat_l	<mbstring.h>

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

使用例

// crt_strncat.c
// Use strcat and strncat to append to a string.
#include <stdlib.h>

#define MAXSTRINGLEN 39

char string[MAXSTRINGLEN+1];
// or char *string = malloc(MAXSTRINGLEN+1);

void BadAppend( char suffix[], int n )
{
   strncat( string, suffix, n );
}

void GoodAppend( char suffix[], size_t n )
{
   strncat( string, suffix, __min( n, MAXSTRINGLEN-strlen(string)) );
}

int main( void )
{
   string[0] = '\0';
   printf( "string can hold up to %d characters\n", MAXSTRINGLEN );

   strcpy( string, "This is the initial string!" );
   // concatenate up to 20 characters...
   BadAppend( "Extra text to add to the string...", 20 );
   printf( "After BadAppend :  %s (%d chars)\n", string, strlen(string) );

   strcpy( string, "This is the initial string!" );
   // concatenate up to 20 characters...
   GoodAppend( "Extra text to add to the string...", 20 );
   printf( "After GoodAppend:  %s (%d chars)\n", string, strlen(string) );
}

出力

string can hold up to 39 characters
After BadAppend :  This is the initial string!Extra text to add to (47 chars)
After GoodAppend:  This is the initial string!Extra text t (39 chars)

バッファオーバーランの原因は BadAppend です。