vsprintf_s, _vsprintf_s_l, vswprintf_s, _vswprintf_s_l

Artigo
06/09/2015

A saída formatada de gravação usando um ponteiro para uma lista de argumentos. Essas são as versões de vsprintf, _vsprintf_l, vswprintf, _vswprintf_l, __vswprintf_l com aprimoramentos de segurança, como descrito em Recursos de segurança no CRT.

int vsprintf_s(
   char *buffer,
   size_t numberOfElements,
   const char *format,
   va_list argptr 
); 
int _vsprintf_s_l(
   char *buffer,
   size_t numberOfElements,
   const char *format,
   locale_t locale,
   va_list argptr 
); 
int vswprintf_s(
   wchar_t *buffer,
   size_t numberOfElements,
   const wchar_t *format,
   va_list argptr 
);
int _vswprintf_s_l(
   wchar_t *buffer,
   size_t numberOfElements,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);
template <size_t size>
int vsprintf_s(
   char (&buffer)[size],
   const char *format,
   va_list argptr 
); // C++ only
template <size_t size>
int vswprintf_s(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   va_list argptr 
); // C++ only

Parâmetros

buffer
Local de armazenamento para saída.
numberOfElements
Tamanho de buffer em caracteres.
format
Especificação de formato.
argptr
Ponteiro para a lista de argumentos.
locale
A localidade a ser usada.

Valor de retorno

vsprintf_s e vswprintf_s retornam o número de caracteres gravados, sem incluir o caractere nulo de terminação ou um valor negativo, no caso de ocorrer um erro de saída. Se buffer ou format for um ponteiro nulo, se o número for zero, ou se a cadeia de formato contiver caracteres de formatação inválidos, o manipulador inválido do parâmetro será chamado, conforme descrito em Validação do parâmetro. Se a execução puder continuar, as funções retornarão -1 e definirão errno como EINVAL.

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

Comentários

Cada uma dessas funções usa um ponteiro para uma lista de argumentos, e nos formatos e grava os dados dados para a memória apontada por buffer.

vswprintf_s está em conformidade com o padrão para vswprintf, que ISO C requer o segundo parâmetro, count, do tipo size_t.

Essas funções são diferentes das versões de não seguras que somente as versões seguros oferecem suporte a parâmetros posicionais. Para obter mais informações, consulte Parâmetros posicionais printf_p.

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 & _MBCS não definido	_MBCS definido	_UNICODE definido
_vstprintf_s	vsprintf_s	vsprintf_s	vswprintf_s
_vstprintf_s_l	_vsprintf_s_l	_vsprintf_s_l	_vswprintf_s_l

Requisitos

Rotina	Cabeçalho necessário	Cabeçalhos opcionais
vsprintf_s, _vsprintf_s_l	<stdio.h> e <stdarg.h>	<varargs.h>*
vswprintf_s, _vswprintf_s_l	<stdio.h> ou <wchar.h> e <stdarg.h>	<varargs.h>*

* Necessário para a compatibilidade de UNIX V.

Para informações adicionais de compatibilidade, consulte Compatibilidade na Introdução.

Exemplo

// crt_vsprintf_s.c
// This program uses vsprintf_s to write to a buffer.
// The size of the buffer is determined by _vscprintf.

#include <stdlib.h>
#include <stdarg.h>

void test( char * format, ... )
{
   va_list args;
   int len;
   char * buffer;

   va_start( args, format );
   len = _vscprintf( format, args ) // _vscprintf doesn't count
                               + 1; // terminating '\0'
   buffer = malloc( len * sizeof(char) );
   vsprintf_s( buffer, len, format, args );
   puts( buffer );
   free( buffer );
}

int main( void )
{
   test( "%d %c %d", 123, '<', 456 );
   test( "%s", "This is a string" );
}