`strncat_s`、 `_strncat_s_l`、 `wcsncat_s`、 `_wcsncat_s_l`、 `_mbsncat_s`、 `_mbsncat_s_l`

[アーティクル]
08/03/2024

文字列に文字を追加します。これらのバージョンのstrncat、_strncat_l、wcsncat、_wcsncat_l、_mbsncat_mbsncat_l、「CRT のSecurity 機能」で説明されているように、セキュリティが強化されています。

重要

_mbsncat_s および _mbsncat_s_l は、Windows ランタイムで実行するアプリケーションでは使用できません。詳細については、「ユニバーサル Windows プラットフォームアプリでサポートされていない CRT 関数」を参照してください。

構文

errno_t strncat_s(
   char *strDest,
   size_t numberOfElements,
   const char *strSource,
   size_t count
);
errno_t _strncat_s_l(
   char *strDest,
   size_t numberOfElements,
   const char *strSource,
   size_t count,
   _locale_t locale
);
errno_t wcsncat_s(
   wchar_t *strDest,
   size_t numberOfElements,
   const wchar_t *strSource,
   size_t count
);
errno_t _wcsncat_s_l(
   wchar_t *strDest,
   size_t numberOfElements,
   const wchar_t *strSource,
   size_t count,
   _locale_t locale
);
errno_t _mbsncat_s(
   unsigned char *strDest,
   size_t numberOfElements,
   const unsigned char *strSource,
   size_t count
);
errno_t _mbsncat_s_l(
   unsigned char *strDest,
   size_t numberOfElements,
   const unsigned char *strSource,
   size_t count,
   _locale_t locale
);
template <size_t size>
errno_t strncat_s(
   char (&strDest)[size],
   const char *strSource,
   size_t count
); // C++ only
template <size_t size>
errno_t _strncat_s_l(
   char (&strDest)[size],
   const char *strSource,
   size_t count,
   _locale_t locale
); // C++ only
template <size_t size>
errno_t wcsncat_s(
   wchar_t (&strDest)[size],
   const wchar_t *strSource,
   size_t count
); // C++ only
template <size_t size>
errno_t _wcsncat_s_l(
   wchar_t (&strDest)[size],
   const wchar_t *strSource,
   size_t count,
   _locale_t locale
); // C++ only
template <size_t size>
errno_t _mbsncat_s(
   unsigned char (&strDest)[size],
   const unsigned char *strSource,
   size_t count
); // C++ only
template <size_t size>
errno_t _mbsncat_s_l(
   unsigned char (&strDest)[size],
   const unsigned char *strSource,
   size_t count,
   _locale_t locale
); // C++ only

パラメーター

strDest
NULL で終わる追加先の文字列。

numberOfElements
コピー先のバッファーのサイズ。

strSource
NULL で終わる元の文字列。

count
追加する文字数、または _TRUNCATE。

locale
使用するロケール。

戻り値

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

エラー条件

`strDestination`	`numberOfElements`	`strSource`	戻り値	`strDestination` の内容
`NULL` または終端文字なし	任意	任意	`EINVAL`	変更されない
任意	任意	`NULL`	`EINVAL`	変更されない
任意	0 または小さすぎる	任意	`ERANGE`	変更されない

解説

これらの関数は、D の最初の strSource 文字を strDest の末尾に追加しようとします。このとき、D は count より小さく、strSource の長さになります。これらの D 文字を追加すると、 strDest 内に収まり (サイズが numberOfElements として指定されます)、null ターミネータの空き領域が残る場合は、それらの文字が追加され、 strDestの元の終端の null から始まり、新しい終端の null が追加されます。それ以外の場合は、 strDest[0] が null 文字に設定され、無効なパラメーターハンドラーが呼び出されます ( パラメーター検証で説明されているように。

上記の段落には例外があります。 countが_TRUNCATE場合、収まる限り多くのstrSourceがstrDestに追加され、終端の null を追加する余地が残ります。

たとえば、にします。

char dst[5];
strncpy_s(dst, _countof(dst), "12", 2);
strncat_s(dst, _countof(dst), "34567", 3);

は、バッファー内の 2 文字に 5 文字の長さに 3 文字を追加するように strncat_s 求めていることを意味します。null ターミネータ用のスペースが残らないので、 strncat_s は文字列をゼロにし、無効なパラメーターハンドラーを呼び出します。

切り捨て動作が必要な場合は、次のように、_TRUNCATE を使用するか、適宜、count を調整します。

strncat_s(dst, _countof(dst), "34567", _TRUNCATE);

または

strncat_s(dst, _countof(dst), "34567", _countof(dst)-strlen(dst)-1);

結果の文字列はすべて、null 文字で終了します。重なり合う文字列間でコピーした場合の動作は未定義です。

strSourceまたはstrDestがNULL、またはnumberOfElementsが 0 の場合、「パラメーターの検証で説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、パラメーターを変更することなく、関数は EINVAL を返します。

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

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

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

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

既定では、この関数のグローバル状態の適用対象は、アプリケーションになります。この動作を変更するには、「CRT でのグローバル状態」を参照してください。

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

TCHAR.H のルーチン	`_UNICODE` と `_MBCS` が定義されていない	`_MBCS` が定義されている	`_UNICODE` が定義されている
`_tcsncat_s`	`strncat_s`	`_mbsnbcat_s`	`wcsncat_s`
`_tcsncat_s_l`	`_strncat_s_l`	`_mbsnbcat_s_l`	`_wcsncat_s_l`

_strncat_s_l と _wcsncat_s_l ロケールに依存しません。これらは _tcsncat_s_lに対してのみ提供されます。

要件

ルーチンによって返される値	必須ヘッダー
`strncat_s`	<string.h>
`wcsncat_s`	<string.h> または <wchar.h>
`_mbsncat_s`, `_mbsncat_s_l`	<mbstring.h>

互換性の詳細については、「 Compatibility」を参照してください。

例

// crt_strncat_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.

errno_t strncat_s_tester( const char * initialDest,
                          const char * src,
                          int count )
{
   char dest[10];
   strcpy_s( dest, _countof(dest), initialDest );

   printf_s( "\n" );

   if ( count == _TRUNCATE )
      printf_s( "Appending '%s' to %d-byte buffer dest with truncation semantics\n",
               src, _countof(dest) );
   else
      printf_s( "Appending %d chars of '%s' to %d-byte buffer dest\n",
              count, src, _countof(dest) );

   printf_s( "    old contents of dest: '%s'\n", dest );

   errno_t err = strncat_s( dest, _countof(dest), src, count );

   printf_s( "    new contents of dest: '%s'\n", dest );

   return err;
}

void Examples()
{
   strncat_s_tester( "hi ", "there", 4 );
   strncat_s_tester( "hi ", "there", 5 );
   strncat_s_tester( "hi ", "there", 6 );

   printf_s( "\nDestination buffer too small:\n" );
   strncat_s_tester( "hello ", "there", 4 );

   printf_s( "\nTruncation examples:\n" );

   errno_t err = strncat_s_tester( "hello ", "there", _TRUNCATE );
   printf_s( "    truncation %s occur\n", err == STRUNCATE ? "did"
                                                       : "did not" );

   err = strncat_s_tester( "hello ", "!", _TRUNCATE );
   printf_s( "    truncation %s occur\n", err == STRUNCATE ? "did"
                                                       : "did not" );

   printf_s( "\nSecure template overload example:\n" );

   char dest[10] = "cats and ";
   strncat( dest, "dachshunds", 15 );
   // With secure template overloads enabled (see #define
   // at top of file), the preceding line is replaced by
   //    strncat_s( dest, _countof(dest), "dachshunds", 15 );
   // Instead of causing a buffer overrun, strncat_s invokes
   // the invalid parameter handler.
   // If secure template overloads were disabled, strncat would
   // append "dachshunds" and overrun the dest buffer.
   printf_s( "    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_s(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();
}

Appending 4 chars of 'there' to 10-byte buffer dest
    old contents of dest: 'hi '
    new contents of dest: 'hi ther'

Appending 5 chars of 'there' to 10-byte buffer dest
    old contents of dest: 'hi '
    new contents of dest: 'hi there'

Appending 6 chars of 'there' to 10-byte buffer dest
    old contents of dest: 'hi '
    new contents of dest: 'hi there'

Destination buffer too small:

Appending 4 chars of 'there' to 10-byte buffer dest
    old contents of dest: 'hello '
Invalid parameter handler invoked: (L"Buffer is too small" && 0)
    new contents of dest: ''

Truncation examples:

Appending 'there' to 10-byte buffer dest with truncation semantics
    old contents of dest: 'hello '
    new contents of dest: 'hello the'
    truncation did occur

Appending '!' to 10-byte buffer dest with truncation semantics
    old contents of dest: 'hello '
    new contents of dest: 'hello !'
    truncation did not occur

Secure template overload example:
Invalid parameter handler invoked: (L"Buffer is too small" && 0)
    new contents of dest: ''

次の方法で共有

`strncat_s`、 `_strncat_s_l`、 `wcsncat_s`、 `_wcsncat_s_l`、 `_mbsncat_s`、 `_mbsncat_s_l`

構文

パラメーター

戻り値

エラー条件

解説

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

要件

例

関連項目

フィードバック

その他のリソース

次の方法で共有

strncat_s、 _strncat_s_l、 wcsncat_s、 _wcsncat_s_l、 _mbsncat_s、 _mbsncat_s_l

構文

パラメーター

戻り値

エラー条件

解説

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

要件

例

関連項目

フィードバック

その他のリソース

`strncat_s`、 `_strncat_s_l`、 `wcsncat_s`、 `_wcsncat_s_l`、 `_mbsncat_s`、 `_mbsncat_s_l`

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