strncat_s， _strncat_s_l， wcsncat_s， _wcsncat_s_l， _mbsncat_s， _mbsncat_s_l

项目
04/10/2013

将字符追加到字符串。这些是 strncat， _strncat_l， wcsncat， wcsncat_l， _mbsncat _mbsncat_l 的版本与安全增强如 CRT中的安全功能所述。

重要

_mbsncat_s 和 _mbsncat_s_l 不能在运行时的窗口执行的应用程序。有关更多信息，请参见 CRT 函数不支持与 /ZW。

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

参数

[out] strDest
null 终止的目标字符串。
[in]numberOfElements
目标缓冲区的大小。
[in]strSource
null 终止的源字符串。
[in]count
追加的字符数或 _TRUNCATE。
[in] locale
使用的区域设置。

返回值

返回 0;如果成功，则失败的错误代码。

错误状态

strDestination	numberOfElements	strSource	返回值	strDestination内容
NULL 或未终止	any	any	EINVAL	不修改
any	any	NULL	EINVAL	不修改
any	0 或太小	any	ERANGE	不修改

备注

这些函数尝试追加 strSource 第一 D 字符。strDest结束时，D 是较小者 count 和 strSource的长度。如果追加这些 D 字符在范围中容纳形式给出 numberOfElements) 的 strDest (和仍 null 结束符的空格，则这些字符追加开始，在终止 null strDest的原始，并且新的终止 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);

意味着我们在缓冲区五个字符请求 strncat_s 长追加三个字符为两个字符；这不会留下 null 结束符，因此 strncat_s 零的空间该字符串和调用无效参数处理程序。

如果截断行为是必需的，请使用 _TRUNCATE 或相应地调整 size 参数：

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 后缀的版本相同，只不过它们使用传入的区域设置参数。有关更多信息，请参见区域设置。

在 C++ 中，使用这些功能由模板超加载简化；超加载可能推断缓冲区长度 (自动不再需要指定范围参数)，并且还可以用以较新，安全重复自动替换旧，不安全的功能。有关更多信息，请参见安全模板重载。

这些函数的" debug "版本用 0xFD 首先加载缓冲区。若要禁用此行为，请使用 _CrtSetDebugFillThreshold。

一般文本例程映射

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>

有关其他的兼容性信息，请参见中介绍的兼容性。

示例

// 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();
}