vsnprintf_s, _vsnprintf_s, _vsnprintf_s_l, _vsnwprintf_s, _vsnwprintf_s_l

Artigo
02/25/2013

Grave a saída formatada usando um ponteiro para uma lista de argumentos.Estas são as versões do vsnprintf, _vsnprintf, _vsnprintf_l, _vsnwprintf, _vsnwprintf_l com aprimoramentos de segurança, conforme descrito em Recursos de segurança no CRT.

int vsnprintf_s(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format,
   va_list argptr 
);
int _vsnprintf_s(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format,
   va_list argptr 
);
int _vsnprintf_s_l(
   char *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const char *format,
   locale_t locale,
   va_list argptr 
);
int _vsnwprintf_s(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format,
   va_list argptr 
);
int _vsnwprintf_s_l(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   size_t count,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);
template <size_t size>
int _vsnprintf_s(
   char (&buffer)[size],
   size_t count,
   const char *format,
   va_list argptr 
); // C++ only
template <size_t size>
int _vsnwprintf_s(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format,
   va_list argptr 
); // C++ only

Parâmetros

buffer
Local de armazenamento para saída.
sizeOfBuffer
O tamanho da buffer para saída, em bytes.
count
Número máximo de caracteres para escrever (não incluindo a terminação nula), ou _TRUNCATE.
format
Especificação de formato.
argptr
Ponteiro para a lista de argumentos.
locale
A localidade para usar.

Para obter mais informações, consulte Especificações de formato.

Valor de retorno

vsnprintf_s,_vsnprintf_s e _vsnwprintf_s retornar o número de caracteres gravados, não incluindo o nulo de terminação ou um valor negativo se ocorrer um erro de saída.vsnprintf_sé idêntico ao _vsnprintf_s.vsnprintf_sé incluído para conformidade com o padrão ANSI._vnsprintfé mantido para compatibilidade com versões anteriores.

Se o armazenamento necessário para armazenar os dados e um valor nulo de terminação exceder sizeOfBuffer, o manipulador de parâmetro inválido é invocado, conforme descrito em Validação de parâmetro, a menos que count é _TRUNCATE, caso em que o máximo da seqüência de caracteres que couberem na buffer é gravado e -1 retornado.Se a execução continua após o manipulador de parâmetro inválido, essas funções definir buffer para uma seqüência vazia, defina errno para ERANGEe retornar -1.

Se 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 terá permissão para continuar, essas funções definir errno para EINVAL e retornar -1.

Condições de erro

Condition	Return	errno
bufferé NULL	-1	EINVAL
formaté NULL	-1	EINVAL
count< = 0	-1	EINVAL
sizeOfBuffertoo small (and count != _TRUNCATE)	-1 (e buffer definido como uma seqüência vazia)	ERANGE

Comentários

Cada uma dessas funções leva um ponteiro para uma lista de argumentos, em seguida, formata e grava até count caracteres do que os dados fornecidos à memória apontado por buffer e o acrescenta um valor nulo de terminação.

Se count é _TRUNCATE, e em seguida, essas funções escrever o máximo da seqüência de caracteres contida no buffer , deixando espaço para um valor nulo de terminação.Se a seqüência inteira (com terminação nula) se encaixa na buffer, e em seguida, essas funções retornam o número de caracteres gravados (não incluindo a terminação nula); Caso contrário, essas funções retornam -1 para indicar que o truncamento ocorreu.

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

Observação de segurança
Certifique-se de que format não é uma seqüência definida pelo usuário.Para obter mais informações, consulte Evitando saturações de Buffer.

Observação
Para garantir que não há espaço para a terminação nula, ter certeza de que count é estritamente menores do que o comprimento do buffer, ou o uso _TRUNCATE.

No C++, a utilização dessas funções é simplificado pela sobrecargas do modelo; os métodos sobrecarregados podem inferir o comprimento do buffer automaticamente (eliminando a necessidade de especificar um argumento de tamanho) e eles podem substituir automaticamente os funções não seguras, mais antigas, com suas contrapartes mais recentes e seguras.Para obter mais informações, consulte Proteger Overloads de modelo.

Mapeamentos de rotina de texto genérico

TCHAR.Rotina H	_ Unicode & _ MBCS do arquivo não definido	_ MBCS do arquivo definido	_ Unicode definido
_vsntprintf_s	_vsnprintf_s	_vsnprintf_s	_vsnwprintf_s
_vsntprintf_s_l	_vsnprintf_s_l	_vsnprintf_s_l	_vsnwprintf_s_l

Equivalência do .NET Framework

Não aplicável. Para chamar a função c padrão, use PInvoke. Para obter mais informações, consulte Exemplos de invocação de plataforma.

Requisitos

Rotina	Cabeçalho necessário	Cabeçalhos opcionais
vsnprintf_s	<stdio.h> e <stdarg.h>	<varargs.h> *
_vsnprintf_s, _vsnprintf_s_l	<stdio.h> e <stdarg.h>	<varargs.h> *
_vsnwprintf_s, _vsnwprintf_s_l	<stdio.h> ou <wchar.h> e <stdarg.h>	<varargs.h> *

* Necessário para compatibilidade de UNIX V.

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

Exemplo

// crt_vsnprintf_s.cpp
#include <stdio.h>
#include <wtypes.h>

void FormatOutput(LPCSTR formatstring, ...) 
{
   int nSize = 0;
   char buff[10];
   memset(buff, 0, sizeof(buff));
   va_list args;
   va_start(args, formatstring);
   nSize = vsnprintf_s( buff, sizeof(buff), _TRUNCATE, formatstring, args);
   printf("nSize: %d, buff: %s\n", nSize, buff);
}

int main() {
   FormatOutput("%s %s", "Hi", "there");
   FormatOutput("%s %s", "Hi", "there!");
   FormatOutput("%s %s", "Hi", "there!!");
}