_snprintf_s, _snprintf_s_l, _snwprintf_s, _snwprintf_s_l

Artigo
06/09/2015

Dados formatados de gravações em uma cadeia de caracteres. Essas são as versões de _snprintf, _snprintf_l, _snwprintf, _snwprintf_l com aprimoramentos de segurança, como descrito em Recursos 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 tamanho do local de armazenamento para saída. Tamanho em bytes para _snprintf_s ou tamanho em words para _snwprintf_s.
Count
Número máximo de caracteres a serem armazenados, ou _TRUNCATE.
format
Cadeia de caracteres de controle de formato.
argument
Argumentos opcionais.
locale
A localidade a ser usada.

Valor de retorno

_snprintf_s retorna o número de caracteres armazenados em buffer, não pelo caractere nulo sendo encerrado. _snwprintf_s retorna o número de caracteres amplos armazenados no buffer, sem contar o caractere amplo nulo de terminação.

Se o armazenamento necessário para armazenar os dados e um nulo encerrando exceder sizeOfBuffer, o manipulador inválido do parâmetro será chamado, conforme descrito em Validação do parâmetro. Se a execução continuará depois que o manipulador inválido do parâmetro, essas funções definem buffer a uma cadeia de caracteres vazia, definem errno a ERANGE, e o retorno -1.

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

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

Comentários

A função de _snprintf_s formata e armazena count ou menos caracteres em buffer e anexará um zero sendo encerrado. Cada argumento (se houver) é convertido e saída de acordo com a especificação de formato correspondente em format. A formatação é consistente com a família de printf das funções; consulte Sintaxe de especificação de formato: funções printf e and wprintf. Se ocorrer cópia entre cadeias de caracteres que se sobrepõem, o comportamento será indefinido.

Se count é _TRUNCATE, então _snprintf_s grava o máximo possível da cadeia de caracteres como caiba em buffer ao sair de espaço para um zero sendo encerrado. Se os que a cadeia de caracteres (com o término do zero) em buffer, em _snprintf_s retornam o número de caracteres gravados (não incluindo o terminador nulo); caso contrário, _snprintf_s retorna -1 para indicar que o truncamento.

Observação de segurança
Verifique se format não é uma cadeia de caracteres definida pelo usuário.

_snwprintf_s é uma versão de caractere largo de _snprintf_s; os argumentos de ponteiro para _snwprintf_s são cadeias de caractere amplo. A detecção de erros de codificação em _snwprintf_s pode ser diferente do que em _snprintf_s. _snwprintf_s, como swprintf_s, grava a saída em uma cadeia de caracteres em vez de em um destino do tipo FILE.

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

No C++, o uso dessas funções é simplificado por sobrecargas de modelo; as sobrecargas podem interpretar o tamanho do buffer automaticamente (eliminando a necessidade de especificar um argumento de tamanho) e podem substituir automaticamente as funções menos seguras mais antigas por correspondentes mais seguras e mais recentes. Para obter mais informações, consulte Sobrecargas de modelo seguras.

Mapeamentos da rotina de texto genérico

Rotina Tchar.h	_UNICODE e _MBCS não definidos	_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 sobre 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();
}