strncat_s、 _strncat_s_l、 wcsncat_s、 _wcsncat_s_l、 _mbsncat_s、 _mbsncat_s_l

發行項
03/26/2013

將字元附加至字串。這些是 strncat、 _strncat_l、 wcsncat、 wcsncat_l、 _mbsncat _mbsncat_l 的安全性增強版本，如安全性功能，則在 CRT 中中所述。

重要

_mbsncat_s 和 _mbsncat_s_l 不能用於 Windows 執行階段執行的應用程式。如需詳細資訊，請參閱 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
innull 結尾的來源字串。
[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 為 strSource_TRUNCATE 然後像符合附加至 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++ 中，使用這些函式由範本多載簡化;多載會推斷緩衝區長度 (自動排除指定大小引數)，也可以用它們較新，安全對應自動取代舊，不安全的函式。如需詳細資訊，請參閱安全範本多載。

這些函式的偵錯版本會先填入 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>

如需其他相容性資訊，請參閱入門介紹中的相容性 (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();
}