_snprintf_s, _snprintf_s_l, _snwprintf_s, _snwprintf_s_l

Artigo
08/25/2010

Dados em uma seqüência de caracteres em formato gravações.Essas são sistema autônomo versões de _snprintf, _snprintf_l, _snwprintf, _snwprintf_l com aprimoramentos de segurança conforme descrito em Aprimoramentos de segurança no CRT.

int _snprintf_s(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format [,
      argument] ... 
);
int _snprintf_s_l(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format,
   locale_t locale [,
      argument] ... 
);
int _snwprintf_s(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format [,
      argument] ... 
);
int _snwprintf_s_l(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format,
   locale_t locale [,
      argument] ... 
);
template <size_t size>
int _snprintf_s(
   char (&buffer)[size],
   size_t count,
   const char *format [,
      argument] ... 
); // C++ only
template <size_t size>
int _snwprintf_s(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format [,
      argument] ... 
); // C++ only

Parâmetros

buffer
Local de armazenamento para a saída.
sizeOfBuffer
O dimensionar do local de armazenamento para saída.dimensionar em bytes para _snprintf_s ou o dimensionar em words para _snwprintf_s.
Count
Número máximo de caracteres para armazenamento ou _TRUNCATE.
format
Seqüência de caracteres de controle de formato.
argument
Argumentos opcionais.
locale
A localidade para usar.

Valor de retorno

_snprintf_s Retorna o número de caracteres armazenados em buffer, sem contar o caractere nulo de terminação. _snwprintf_s Retorna o número de caracteres largos armazenadas no buffer, sem contar o caractere de largo nulo terminação.

Se o armazenamento necessário para armazenar sistema autônomo dados e um nulo de terminação exceder sizeOfBuffer, o manipulador de parâmetro inválido é chamado, conforme descrito em Validação de parâmetro. Se continuar execução após o manipulador de parâmetro inválido, essas funções conjunto buffer para uma seqüência vazia, defina errno para ERANGEe retornar -1.

If buffer ou format é um NULL ponteiro, ou se count é menor ou igual a zero, o manipulador de parâmetro inválido é invocado. Se a execução for permitida para continuar, essas funções conjunto errno para EINVAL e retornar -1.

Para obter informações sobre esses e outros códigos de erro, consulte _doserrno, errno, _sys_errlist e _sys_nerr.

Comentários

The _snprintf_s formatos de função e armazenamentos count caracteres ou menos em buffer e o acrescenta uma terminação nulo. Cada argumento (se houver) é convertido e saído de acordo com a especificação de formato correspondente em format. A formatação é consistente com o printf família de funções; consulte Campos de especificação de formato: Funções de printf e wprintf. Se copiar ocorrer entre cadeias de caracteres que se sobrepõem, o comportamento é indefinido.

If count é _TRUNCATE, em seguida, _snprintf_s grava sistema autônomo da seqüência de caracteres sistema autônomo couberem na buffer deixando espaço para uma terminação nula. Se a seqüência inteira (com terminação nula) se encaixa no buffer, em seguida, _snprintf_s Retorna o número de caracteres gravada (não incluindo a terminação nula); caso contrário, _snprintf_s Retorna -1 para indicar que o truncamento ocorreu.

Observação de segurança:
Certifique-se de que format não é uma seqüência de caracteres definida pelo usuário.

_snwprintf_s é uma versão de caractere largo da _snprintf_s; os argumentos de ponteiro _snwprintf_s são seqüências de caracteres largos. Detecção de erros em de codificação_snwprintf_s pode ser diferente no _snprintf_s. _snwprintf_s, como swprintf_s, grava a saída para uma seqüência de caracteres em vez de um destino de tipo FILE.

As versões dessas funções com o _l sufixo são idênticas exceto que usarem o parâmetro de localidade passado em vez da localidade do thread corrente.

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.

Mapeamentos de rotina de texto genérica

Rotina tchar.h	_UNICODE e _MBCS não definido	_MBCS definido	_UNICODE definido
_sntprintf_s	_snprintf_s	_snprintf_s	_snwprintf_s
_sntprintf_s_l	_snprintf_s_l	_snprintf_s_l	_snwprintf_s_l

Requisitos

Rotina	Cabeçalho necessário
_snprintf_s, _snprintf_s_l	<stdio.h>
_snwprintf_s, _snwprintf_s_l	<stdio.h> ou <wchar.h>

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

Exemplo

// crt_snprintf_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.

int snprintf_s_tester( const char * fmt, int x, int count )
{
   char dest[10];

   printf( "\n" );

   if ( count == _TRUNCATE )
      printf( "%d-byte buffer; truncation semantics\n",
               _countof(dest) );
   else
      printf( "count = %d; %d-byte buffer\n",
               count, _countof(dest) );

   int ret = _snprintf_s( dest, _countof(dest), count, fmt, x );

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

   return ret;
}


void Examples()
{
   // formatted output string is 9 characters long: "<<<123>>>"
   snprintf_s_tester( "<<<%d>>>", 121, 8 );
   snprintf_s_tester( "<<<%d>>>", 121, 9 );
   snprintf_s_tester( "<<<%d>>>", 121, 10 );

   printf( "\nDestination buffer too small:\n" );

   snprintf_s_tester( "<<<%d>>>", 1221, 10 );

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

   int ret = snprintf_s_tester( "<<<%d>>>", 1221, _TRUNCATE );
   printf( "    truncation %s occur\n", ret == -1 ? "did"
                                                  : "did not" );

   ret = snprintf_s_tester( "<<<%d>>>", 121, _TRUNCATE );
   printf( "    truncation %s occur\n", ret == -1 ? "did"
                                                  : "did not" );
   printf( "\nSecure template overload example:\n" );

   char dest[10];
   _snprintf( dest, 10, "<<<%d>>>", 12321 );
   // With secure template overloads enabled (see #defines
   // at top of file), the preceding line is replaced by
   //    _snprintf_s( dest, _countof(dest), 10, "<<<%d>>>", 12345 );
   // Instead of causing a buffer overrun, _snprintf_s invokes
   // the invalid parameter handler.
   // If secure template overloads were disabled, _snprintf would
   // write 10 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();
}

 count = 8; 10-byte buffer     new contents of dest: '<<<121>>'  count = 9; 10-byte buffer     new contents of dest: '<<<121>>>'  count = 10; 10-byte buffer     new contents of dest: '<<<121>>>'  Destination buffer too small:  count = 10; 10-byte buffer Invalid parameter handler invoked: ("Buffer too small", 0)     new contents of dest: ''  Truncation examples:  10-byte buffer; truncation semantics     new contents of dest: '<<<1221>>'     truncation did occur  10-byte buffer; truncation semantics     new contents of dest: '<<<121>>>'     truncation did not occur  Secure template overload example: Invalid parameter handler invoked: ("Buffer too small", 0)     new contents of dest: ''