vsnprintf_s, _vsnprintf_s, _vsnprintf_s_l, _vsnwprintf_s, _vsnwprintf_s_l

Artigo
08/25/2010

gravar formatado usando um ponteiro para uma lista de argumentos de saída.Essas são sistema autônomo versões de vsnprintf, _vsnprintf, _vsnprintf_l, _vsnwprintf, _vsnwprintf_l com aprimoramentos de segurança conforme descrito em Aprimoramentos 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 dimensionar do buffer para saída.
count
Número máximo de caracteres para escrever (não incluindo a terminação nulo), ou _TRUNCATE.
format
Especificação de formato.
argptr
Ponteiro para a lista de argumentos.
locale
A localidade para usar.

Valor de retorno

vsnprintf_s,_vsnprintf_s and _vsnwprintf_s return the number of characters written, not including the terminating null, or a negative value if an output error occurs.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 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, a menos que count é _TRUNCATE, caso em que o máximo da seqüência de caracteres sistema autônomo irá ajuste em buffer foi criado e retornado -1. 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.

Condições de erro

Condition	Return	errno
buffer é NULL	-1	EINVAL
format é NULL	-1	EINVAL
count <= 0	-1	EINVAL
sizeOfBuffer muito pequeno (e count != _TRUNCATE)	-1 (and buffer conjunto para 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 count caracteres dos dados fornecidos para a memória apontado por buffer e o acrescenta uma terminação nulo.

If count é _TRUNCATE, e, em seguida, escrever essas funções sistema autônomo da seqüência de caracteres sistema autônomo couberem na buffer deixando espaço para uma terminação nula. Se toda a seqüência de caracteres (com terminação nulo) se encaixa no buffer, e em seguida, essas funções retornam o número de caracteres gravada (não incluindo a terminação nulo); 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 usarem o parâmetro de localidade passado em vez da localidade do thread corrente.

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

Observação:
Para garantir que haja espaço para a terminação nula, certifique-se de que count são estritamente menores do que o comprimento do buffer ou uso _TRUNCATE.

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 & _MBCS não definido	_MBCS definido	_UNICODE definido
_vsntprintf_s	_vsnprintf_s	_vsnprintf_s	_vsnwprintf_s
_vsntprintf_s_l	_vsnprintf_s_l	_vsnprintf_s_l	_vsnwprintf_s_l

Equivalente do NET Framework

Não aplicável. Para telefonar 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 UNIX V.

Para obter informações adicionais 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!!");
}

nSize: 8, buff: Hi there nSize: 9, buff: Hi there! nSize: -1, buff: Hi there!