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 中的安全功能中所述。

重要

_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` 或未终止	任意	any	`EINVAL`	未修改
any	any	`NULL`	`EINVAL`	未修改
任意	0 或过小	any	`ERANGE`	未修改

注解

这些函数尝试将 strSource 的前 D 个字符追加到 strDest 末尾，其中 D 是 count 和 strSource 长度中较小的一个。如果追加这D个字符将适合strDest（其大小给定为numberOfElements），并且仍有空间追加 null 终止符，则这些字符将从strDest的原始终止 null 位置开始追加，并会追加一个新的终止 null 字符；否则，strDest[0]设置为 null 字符，并调用无效的参数处理程序，如参数验证中所述。

上面的段落有一个例外。如果count是_TRUNCATE，则在仍有空间追加终止 null 字符时，会尽可能多的将strSource追加到strDest。

例如，

char dst[5];
strncpy_s(dst, _countof(dst), "12", 2);
strncat_s(dst, _countof(dst), "34567", 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为零，则将调用无效参数处理程序，如参数验证中所述。如果允许执行继续，则函数返回 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>
%>	<mbstring.h>

有关兼容性的详细信息，请参阅兼容性。

示例

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

另请参阅

字符串操作
 区域设置
 多字节字符序列的解释
%>
.- .
.- .
.- .

通过

语法

参数

返回值

错误条件

注解

一般文本例程映射

要求

示例

另请参阅

反馈

其他资源