strncpy_s, _strncpy_s_l, wcsncpy_s, _wcsncpy_s_l, _mbsncpy_s, _mbsncpy_s_l

Artigo
08/25/2010

Copie caracteres de uma seqüência de caracteres para outro.Essas são sistema autônomo versões de funções strncpy, _strncpy_l, wcsncpy, _wcsncpy_l, _mbsncpy, _mbsncpy_l com aprimoramentos de segurança conforme descrito em Aprimoramentos de segurança no CRT.

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

Parâmetros

strDest
Seqüência de caracteres de destino.
numberOfElements
O dimensionar da seqüência de destino, em caracteres.
strSource
Seqüência de caracteres de fonte.
count
Número de caracteres a serem copiados ou _TRUNCATE.
locale
A localidade para usar.

Valor de retorno

Zero se for bem-sucedido, caso contrário, um código de erro.

Condições de erro

strDest	numberOfElements	strSource	Valor de Retorno	Sumário de strDest
NULL	any	any	EINVAL	não modificado
any	any	NULL	EINVAL	strDest[0] conjunto para 0
any	0	any	EINVAL	não modificado
not NULL	muito pequeno	any	EINVAL	strDest[0] conjunto para 0

Comentários

Essas funções tentam copiar o primeiro D caracteres do strSource para strDest, onde D é inferior a count e o comprimento do strSource. Se esses D caracteres serão ajuste dentro strDest (cujo dimensionar é fornecido sistema autônomo numberOfElements) e ainda deixar espaço para um terminador nulo, em seguida, esses caracteres são copiados e um nulo de terminação for anexado; caso contrário, strDest[0] é definido sistema autônomo o caractere nulo e o parâmetro inválido manipulador é chamado, conforme descrito em Validação de parâmetro.

Há uma exceção para o parágrafo acima.If count é _TRUNCATE, em seguida, o máximo de strSource sistema autônomo caberá em strDest é copiado enquanto ainda deixa espaço para o terminação nulo que é sempre anexado.

Por exemplo,

char dst[5];

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

significa que nós estão perguntando strncpy_s Para copiar os cinco caracteres em um buffer de cinco bytes longo; Isso deixaria nenhum espaço para que o terminador nulo, daí strncpy_s zeros fora de seqüência e chama o manipulador de parâmetro inválido.

Se for necessário truncamento de comportamento, use _TRUNCATE ou)size – 1):

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

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

Observe que, ao contrário de strncpy, se count é maior do que o comprimento de strSource, a seqüência de caracteres de destino não é preenchida com caracteres nulo até comprimento count.

O comportamento de strncpy_s é indefinido se sobreponham as seqüências de caracteres de fonte e destino.

If strDest ou strSource é NULL, ou numberOfElements é 0, o manipulador de parâmetro inválido é chamado. Se a execução terá permissão para continuar, a função retornará EINVAL e conjuntos errno para EINVAL.

wcsncpy_s e _mbsncpy_ssão versões de caractere largo e caracteres de multibyte de strncpy_s. The arguments and return value of wcsncpy_s and mbsncpy_sdo vary accordingly.Esses seis funções se comportam exatamente caso contrário.

O valor de saída é afetado pela configuração do LC_CTYPE categoria de configuração da localidade; consulte setlocale para obter mais informações.As versões dessas funções sem o _l sufixo use a localidade corrente para esse comportamento dependente de localidade; as versões com o _l sufixo são idênticas exceto que usarem o parâmetro de localidade passado em vez disso. For more information, see Localidade.

No C++, usando essas funções é simplificado pelo modelo sobrecargas; sobrecargas de podem inferir o comprimento do buffer automaticamente (eliminando a necessidade de especificar um argumento de dimensionar) e eles podem substituir automaticamente funções não seguras, mais antigas, com suas contrapartes mais recentes e seguras.For more information, see Proteger overloads de modelo.

As versões de depurar dessas funções primeiro preenchem o buffer com 0xFD.Para desabilitar esse comportamento, use _CrtSetDebugFillThreshold.

Mapeamentos de rotina de texto genérica

Rotina TCHAR.H	_UNICODE & _MBCS não definido	_MBCS definido	_UNICODE definido
_tcsncpy_s	strncpy_s	_mbsnbcpy_s	wcsncpy_s
_tcsncpy_s_l	_strncpy_s_l	_mbsnbcpy_s_l	_wcsncpy_s_l

Observação:
_strncpy_s_l , _wcsncpy_s_l e _mbsncpy_s_l não ter nenhuma dependência de localidade e são fornecidos apenas para _tcsncpy_s_l e não têm por objetivo ser chamado diretamente.

Requisitos

Rotina	Cabeçalho necessário
strncpy_s, _strncpy_s_l	<string.h>
wcsncpy_s, _wcsncpy_s_l	<string.h> ou <wchar.h>
_mbsncpy_s, _mbsncpy_s_l	<mbstring.h>

Para obter informações adicionais compatibilidade, consulte Compatibilidade na introdução.

Exemplo

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

 Copying 4 chars of 'howdy' to 10-byte buffer dest     new contents of dest: 'howd'  Copying 5 chars of 'howdy' to 10-byte buffer dest     new contents of dest: 'howdy'  Copying 6 chars of 'howdy' to 10-byte buffer dest     new contents of dest: 'howdy'  Destination buffer too small:  Copying 10 chars of 'Hi there!!' to 10-byte buffer dest Invalid parameter handler invoked: (L"Buffer is too small" && 0)     new contents of dest: ''  Truncation examples:  Copying 'How do you do?' to 10-byte buffer dest with truncation semantics     new contents of dest: 'How do yo'     truncation did occur  Copying 'Howdy.' to 10-byte buffer dest with truncation semantics     new contents of dest: 'Howdy.'     truncation did not occur  Secure template overload example: Invalid parameter handler invoked: (L"Buffer is too small" && 0)     new contents of dest: ''

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

}

Original string:    'dogs like cats' After strncpy (no null-termination):    'mice like cats' After strncpy into middle of string:    'mice love cats' After strncpy_s (with null-termination):    'mice'