vsnprintf_s, _vsnprintf_s, _vsnprintf_s_l, , _vsnwprintf_s, _vsnwprintf_s_l

Escribe un resultado con formato mediante un puntero a una lista de argumentos. Estas funciones son versiones de vsnprintf, _vsnprintf, _vsnprintf_l, _vsnwprintfcon _vsnwprintf_l mejoras de seguridad, como se describe en Características de seguridad de CRT.

Sintaxis

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
Ubicación de almacenamiento del resultado.

sizeOfBuffer
Tamaño de para buffer la salida. Tamaño en bytes para las funciones que toman chary palabras para las que toman wchar_t.

count
Número máximo de caracteres que se van a escribir sin incluir la terminación NULL. Para las funciones que toman wchar_t, es el número de caracteres anchos que se van a escribir. O _TRUNCATE.

format
Especificación de formato.

argptr
Puntero a la lista de argumentos.

locale
La configuración regional que se va a usar al dar formato a la salida.

Para obtener más información, consulte Especificaciones de formato.

Valor devuelto

Número de caracteres escritos, sin incluir el terminado NULLo un valor negativo si se produce un error de salida.

Consulte Resumen del comportamiento para obtener más información.

Comentarios

vsnprintf_s es idéntico a _vsnprintf_s y se incluye para cumplir el estándar ANSI. La clase _vnsprintf se conserva por razones de compatibilidad con versiones anteriores.

Cada una de estas funciones toma un puntero a una lista de argumentos, después da formato a un máximo de count caracteres, y los escribe, de los datos especificados en la memoria a la que señala buffer y anexa un carácter nulo final.

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.

Resumen del comportamiento

Para la tabla siguiente:

• Vamos len a ser el tamaño de los datos con formato. Si la función toma un char búfer, el tamaño está en bytes. Si la función toma un wchar_t búfer, el tamaño especifica el número de palabras de 16 bits.
• Los caracteres hacen referencia a char caracteres para funciones que toman un char búfer y a wchar_t caracteres para las funciones que toman un wchar_t búfer.
• Para obtener más información sobre el controlador de parámetros no válidos, vea Validación de parámetros.

Para información sobre estos y otros códigos de error, consulte _doserrno, errno_sys_errlist y _sys_nerr.

En C++, el uso de estas funciones se simplifica con las sobrecargas de plantilla; las sobrecargas pueden realizar una inferencia automáticamente de la longitud de búfer (lo que elimina el requisito de especificar un argumento de tamaño) y pueden reemplazar automáticamente funciones anteriores no seguras con sus homólogos seguros más recientes. Para obtener más información, consulte Sobrecargas de plantilla seguras.

Asignaciones de rutinas de texto genérico

Requisitos

* Se requiere para la compatibilidad con UNIX V.

Para obtener más información sobre compatibilidad, consulte Compatibilidad.

Ejemplo

// 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, _countof(buff), _TRUNCATE, formatstring, args);
   printf("nSize: %d, buff: %s\n", nSize, buff);
   va_end(args);
}

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!

Vea también

E/S de secuencia
Funciones vprintf
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