vsprintf, _vsprintf_l, vswprintf, _vswprintf_l, __vswprintf_l

Artículo
06/09/2015

Escribe un resultado con formato mediante un puntero a una lista de argumentos. Hay disponibles versiones más seguras de estas funciones; vea vsprintf_s, _vsprintf_s_l, vswprintf_s, _vswprintf_s_l.

int vsprintf(
   char *buffer,
   const char *format,
   va_list argptr 
); 
int _vsprintf_l(
   char *buffer,
   const char *format,
   locale_t locale,
   va_list argptr 
); 
int vswprintf(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   va_list argptr 
);
int _vswprintf_l(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);
int __vswprintf_l(
   wchar_t *buffer,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);
template <size_t size>
int vsprintf(
   char (&buffer)[size],
   const char *format,
   va_list argptr 
); // C++ only
template <size_t size>
int _vsprintf_l(
   char (&buffer)[size],
   const char *format,
   locale_t locale,
   va_list argptr 
); // C++ only
template <size_t size>
int vswprintf(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   va_list argptr 
); // C++ only
template <size_t size>
int _vswprintf_l(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
); // C++ only

Parámetros

buffer
Ubicación de almacenamiento del resultado.
count
Número máximo de caracteres que se van a almacenar, en la versión UNICODE de esta función.
format
Especificación de formato.
argptr
Puntero a la lista de argumentos.
locale
Configuración regional que se va a usar.

Valor devuelto

vsprintf y vswprintf devuelven el número de caracteres escritos, sin incluir el carácter de terminación nulo, o un valor negativo si se produce un error de salida. Si buffer o format es un puntero nulo, estas funciones invocan el controlador de parámetros no válidos, como se describe en Validación de parámetros. Si la ejecución puede continuar, estas funciones devuelven -1 y establecen errno en EINVAL.

Para obtener información sobre estos y otros códigos de error, vea _doserrno, errno, _sys_errlist y _sys_nerr.

Comentarios

Cada una de estas funciones toma un puntero a una lista de argumentos y, a continuación, aplica formato a los datos determinados y los escribe en la memoria a la que señala buffer.

Las versiones de estas funciones con el sufijo _l son idénticas salvo que usan el parámetro locale pasado en lugar de la configuración regional del subproceso actual.

Nota sobre la seguridad
Al utilizar vsprintf, no hay forma de limitar el número de caracteres escritos, lo que significa que el código que utilice esta función es susceptible de saturaciones del búfer.En su lugar, use _vsnprintf, o llame a _vscprintf para determinar el tamaño de búfer necesario.Además, asegúrese de que format no es una cadena definida por el usuario.Para obtener más información, vea Evitar saturaciones del búfer.

Al utilizar vsprintf, no hay forma de limitar el número de caracteres escritos, lo que significa que el código que utilice esta función es susceptible de saturaciones del búfer.En su lugar, use _vsnprintf, o llame a _vscprintf para determinar el tamaño de búfer necesario.Además, asegúrese de que format no es una cadena definida por el usuario.Para obtener más información, vea Evitar saturaciones del búfer.

vswprintf se ajusta a ISO C estándar, que requiere el segundo parámetro, count, de tipo size_t. Para imponer el comportamiento no estándar anterior, defina _CRT_NON_CONFORMING_SWPRINTFS. El comportamiento anterior no puede estar en una versión posterior, por lo que el código se debe cambiar de forma que use el nuevo comportamiento estándar.

En C++, estas funciones tienen sobrecargas de plantilla que invocan los homólogos seguros más recientes de estas funciones. Para obtener más información, vea Sobrecargas de plantilla seguras.

Asignaciones de rutina de texto genérico

Rutina TCHAR.H	_UNICODE y _MBCS no definidos	_MBCS definido	_UNICODE definido
_vstprintf	vsprintf	vsprintf	vswprintf
_vstprintf_l	_vsprintf_l	_vsprintf_l	_vswprintf_l

Requisitos

Rutina	Encabezado necesario	Encabezados opcionales
vsprintf, _vsprintf_l	<stdio.h> y <stdarg.h>	<varargs.h>*
vswprintf, _vswprintf_l	<stdio.h> o <wchar.h>, y <stdarg.h>	<varargs.h>*

* Necesario para la compatibilidad con UNIX V.

Para obtener información adicional de compatibilidad, vea Compatibilidad en la Introducción.

Ejemplo

// crt_vsprintf.c
// compile with: /W3
// This program uses vsprintf 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 * format, ... )
{
    va_list args;
    int     len;
    char    *buffer;

    // retrieve the variable arguments
    va_start( args, format );
    
    len = _vscprintf( format, args ) // _vscprintf doesn't count
                                + 1; // terminating '\0'
    
    buffer = (char*)malloc( len * sizeof(char) );

    vsprintf( buffer, format, args ); // C4996
    // Note: vsprintf is deprecated; consider using vsprintf_s instead
    puts( buffer );

    free( buffer );
}

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