vsprintf_s, _vsprintf_s_l, vswprintf_s, _vswprintf_s_l

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

Sintaxe

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 de 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 Retornado

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

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

Comentários

Cada uma dessas funções usa um ponteiro para uma lista de argumentos, em seguida, formata e grava os dados determinados na memória apontada por buffer.

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

Essas funções são diferentes das versões não seguras apenas no sentido de que as versões seguras dão suporte a parâmetros posicionais. Para obter mais informações, confira Parâmetros posicionais printf_p.

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

No C++, o uso dessas funções é simplificado por sobrecargas de modelo. As sobrecargas podem inferir automaticamente o tamanho do buffer, eliminando a necessidade de especificar um argumento de tamanho. E, eles podem substituir automaticamente funções não seguras por seus equivalentes seguros. Para obter mais informações, consulte Sobrecargas de modelo seguro.

Importante

Começando pelo Windows 10 versão 2004 (build 19041), a família de funções printf imprime números de ponto flutuante exatamente representáveis de acordo com as regras do IEEE 754 para arredondamento. Em versões anteriores do Windows, números de ponto flutuante que pudessem ser representados com exatidão e que terminassem em "5" eram sempre arredondados para cima. O IEEE 754 afirma que eles devem arredondar para o dígito par mais próximo (também conhecido como "arredondamento do banqueiro"). Por exemplo, ambos printf("%1.0f", 1.5) e printf("%1.0f", 2.5) devem ser arredondados para 2. Anteriormente, 1,5 seria arredondado para 2 e 2,5 para 3. Essa alteração afeta apenas números que possam ser representados com exatidão. Por exemplo, 2,35 (que, quando representado na memória, está mais próximo de 2,35000000000000008) continua arredondando para 2,4. O arredondamento feito por essas funções agora também respeita o modo de arredondamento de ponto flutuante definido por fesetround. Anteriormente, o arredondamento sempre escolhia o comportamento FE_TONEAREST. Essa alteração afeta apenas os programas criados com o Visual Studio 2019 versão 16.2 e posteriores. Para usar o comportamento de arredondamento de ponto flutuante herdado, vincule-o a 'legacy_stdio_float_rounding.obj'.

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 compatibilidade com UNIX V.

Para obter mais informações sobre compatibilidade, consulte Compatibilidade.

Exemplo

// crt_vsprintf_s.c
// Compile with: cl /W4 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 <stdio.h>
#include <stdarg.h>

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

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

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

Confira também

E/S de fluxo
Funções vprintf
Sintaxe de especificação de formato: funções printf e wprintf
fprintf, _fprintf_l, fwprintf, _fwprintf_l
printf, _printf_l, wprintf, _wprintf_l
sprintf, _sprintf_l, swprintf, _swprintf_l, \__swprintf_l
va_arg, va_copy, va_end, va_start