strncpy_s, _strncpy_s_l, wcsncpy_s, _wcsncpy_s_l, _mbsncpy_s, _mbsncpy_s_l

Článek
03/26/2013

Zkopírujte jeden řetězec znaků do jiného.Jedná se o verze strncpy, _strncpy_l, wcsncpy, _wcsncpy_l, _mbsncpy, _mbsncpy_l s vylepšení zabezpečení, jak je popsáno v Funkce zabezpečení v CRT.

Důležité
_mbsncpy_sa _mbsncpy_s_l nelze použít v aplikacích, které jsou spuštěny v systému Windows Runtime.Další informace naleznete v tématu CRT funkce nejsou podporovány s /ZW.

errno_t strncpy_s(
   char *strDest,
   size_t numberOfElements,
   const char *strSource,
   size_t count
);
errno_t _strncpy_s_l(
   char *strDest,
   size_t numberOfElements,
   const char *strSource,
   size_t count,
   _locale_t locale
);
errno_t wcsncpy_s(
   wchar_t *strDest,
   size_t numberOfElements,
   const wchar_t *strSource,
   size_t count 
);
errno_t _wcsncpy_s_l(
   wchar_t *strDest,
   size_t numberOfElements,
   const wchar_t *strSource,
   size_t count,
   _locale_t locale
);
errno_t _mbsncpy_s(
   unsigned char *strDest,
   size_t numberOfElements,
   const unsigned char *strSource,
   size_t count 
);
errno_t _mbsncpy_s_l(
   unsigned char *strDest,
   size_t numberOfElements,
   const unsigned char *strSource,
   size_t count,
   locale_t locale
);
template <size_t size>
errno_t strncpy_s(
   char (&strDest)[size],
   const char *strSource,
   size_t count
); // C++ only
template <size_t size>
errno_t _strncpy_s_l(
   char (&strDest)[size],
   const char *strSource,
   size_t count,
   _locale_t locale
); // C++ only
template <size_t size>
errno_t wcsncpy_s(
   wchar_t (&strDest)[size],
   const wchar_t *strSource,
   size_t count 
); // C++ only
template <size_t size>
errno_t _wcsncpy_s_l(
   wchar_t (&strDest)[size],
   const wchar_t *strSource,
   size_t count,
   _locale_t locale
); // C++ only
template <size_t size>
errno_t _mbsncpy_s(
   unsigned char (&strDest)[size],
   const unsigned char *strSource,
   size_t count 
); // C++ only
template <size_t size>
errno_t _mbsncpy_s_l(
   unsigned char (&strDest)[size],
   const unsigned char *strSource,
   size_t count,
   locale_t locale
); // C++ only

Parametry

strDest
Cílový řetězec.
numberOfElements
Velikost cílový řetězec znaků.
strSource
Zdrojový řetězec.
count
Počet znaků, které chcete kopírovat, nebo _TRUNCATE.
locale
Národní prostředí pro použití.

Vrácená hodnota

Nula v případě úspěchu, STRUNCATE Pokud zkrácení jinak došlo k chybě.

Chybové stavy

strDest	numberOfElements	strSource	Vrácená hodnota	ObsahstrDest
NULL	všechny	všechny	EINVAL	Nezměněno
všechny	všechny	NULL	EINVAL	strDest[0] nastavena na 0
všechny	0	všechny	EINVAL	Nezměněno
neníNULL	příliš malá.	všechny	ERANGE	strDest[0] nastavena na 0

Poznámky

Tyto funkce se pokusí zkopírovat první D znaky strSource na strDest, kde D je nižší z count a strSource.Pokud tyto D znaků vejde do strDest (jejíž velikost je uvedena jako numberOfElements) a ponechat prostor pro null zakončení a potom tyto znaky jsou zkopírovány a je připojen ukončující null; jinak strDest[0] je nastavena na znak null a neplatný parametr je vyvolána obslužná rutina, jak je popsáno v Ověření parametrů.

Existuje výjimka do výše uvedeného odstavce.Pokud count je _TRUNCATE, poté co největší část strSource jako vejde do strDest zkopírován přitom stále ponechat prostor pro ukončující null, který je vždy připojen.

Příklad:

char dst[5];

strncpy_s(dst, 5, "a long string", 5);

znamená, že jsme s požadavkem strncpy_s kopírovat pět znaků do vyrovnávací paměti pět bajtů, který je dlouhý; To by zanechala není místo pro null zakončení, tedy strncpy_s souvislou mimo řetězec a zavolá obslužnou rutinu neplatný parametr.

Potřeby zkrácení chování pomocí _TRUNCATE nebo (size – 1):

strncpy_s(dst, 5, "a long string", _TRUNCATE);

strncpy_s(dst, 5, "a long string", 4);

Všimněte si, že na rozdíl od strncpy, pokud count je větší než délka strSource, cílový řetězec není nulami znaky null až do délky count.

Chování strncpy_s není definován, je-li překrytí řetězce zdrojové a cílové.

Pokud strDest nebo strSource je NULL, nebo numberOfElements je 0, je vyvolána obslužná rutina neplatný parametr.Pokud je povoleno zpracování, chcete-li pokračovat, vrátí funkce EINVAL a errno na EINVAL.

wcsncpy_sa _mbsncpy_s jsou verze širokého znaku a vícebajtové znakové sady strncpy_s.Argumenty a vrácené hodnoty wcsncpy_s a mbsncpy_s se liší podle toho.Těchto šest funkcí chovat identicky jinak.

Výstupní hodnota je ovlivněna nastavením LC_CTYPE kategorie nastavení národního prostředí; Viz setlocale pro další informace.Verze těchto funkcí, aniž by _l příponu použít aktuální národní prostředí pro toto chování závislé na národním prostředí; verze s _l s tím rozdílem, že používají místo něho předán parametr locale shodná přípona.Další informace naleznete v tématu Národní prostředí.

V jazyce C++ pomocí těchto funkcí je zjednodušeno díky přetížení šablony; přetížení můžete automaticky odvodit velikost vyrovnávací paměti (není tedy třeba zadat argument velikost) a starší, nezabezpečené funkce lze automaticky nahradí s jejich protějšky novější, bezpečné.Další informace naleznete v tématu Přetížení šablony zabezpečení.

Ladicí verze těchto funkcí vyplnit nejprve vyrovnávací paměť s 0xFD.Chcete-li zakázat toto chování, použijte _CrtSetDebugFillThreshold.

Mapování rutiny obecného textu

TCHAR.Byla zahájena rutina h	_UNICODE & _MBCS není definováno	_MBCS, definice	_UNICODE definována
_tcsncpy_s	strncpy_s	_mbsnbcpy_s	wcsncpy_s
_tcsncpy_s_l	_strncpy_s_l	_mbsnbcpy_s_l	_wcsncpy_s_l

[!POZNÁMKA]

_strncpy_s_l, _wcsncpy_s_l a _mbsncpy_s_l mít závislost národního prostředí a jsou k dispozici pouze pro _tcsncpy_s_l a nemají být volán přímo.

Požadavky

Byla zahájena rutina	Požadované záhlaví
strncpy_s, _strncpy_s_l	<string.h>
wcsncpy_s, _wcsncpy_s_l	<string.h> nebo <wchar.h>
_mbsncpy_s, _mbsncpy_s_l	<mbstring.h>

Další informace o kompatibilitě, viz Compatibility v úvodu.

Příklad

// crt_strncpy_s_1.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 strncpy_s_tester( const char * src,
                          int count )
{
   char dest[10];

   printf( "\n" );

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

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

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

   return err;
}


void Examples()
{
   strncpy_s_tester( "howdy", 4 );
   strncpy_s_tester( "howdy", 5 );
   strncpy_s_tester( "howdy", 6 );

   printf( "\nDestination buffer too small:\n" );
   strncpy_s_tester( "Hi there!!", 10 );

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

   errno_t err = strncpy_s_tester( "How do you do?", _TRUNCATE );
   printf( "    truncation %s occur\n", err == STRUNCATE ? "did"
                                                       : "did not" );

   err = strncpy_s_tester( "Howdy.", _TRUNCATE );
   printf( "    truncation %s occur\n", err == STRUNCATE ? "did"
                                                       : "did not" );

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

   char dest[10];
   strncpy( dest, "very very very long", 15 );
   // With secure template overloads enabled (see #defines at
   // top of file), the preceding line is replaced by
   //    strncpy_s( dest, _countof(dest), "very very very long", 15 );
   // Instead of causing a buffer overrun, strncpy_s invokes
   // the invalid parameter handler.
   // If secure template overloads were disabled, strncpy would
   // copy 15 characters and overrun the dest buffer.
   printf( "    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(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();
}

// crt_strncpy_s_2.c
// contrasts strncpy and strncpy_s

#include <stdio.h>
#include <stdlib.h>

int main( void )
{
   char a[20] = "test";
   char s[20];

   // simple strncpy usage:

   strcpy_s( s, 20, "dogs like cats" );
   printf( "Original string:\n   '%s'\n", s );

   // Here we can't use strncpy_s since we don't 
   // want null termination
   strncpy( s, "mice", 4 );
   printf( "After strncpy (no null-termination):\n   '%s'\n", s );
   strncpy( s+5, "love", 4 );
   printf( "After strncpy into middle of string:\n   '%s'\n", s );

   // If we use strncpy_s, the string is terminated 
   strncpy_s( s, _countof(s), "mice", 4 );
   printf( "After strncpy_s (with null-termination):\n   '%s'\n", s );

}