Compartir a través de


vsnprintf_s, _vsnprintf_s, _vsnprintf_s_l, , _vsnwprintf_s, _vsnwprintf_s_l

Escriba una salida con formato mediante un puntero a una lista de argumentos. Estas funciones son versiones de , vsnprintf, _vsnprintf, , _vsnprintf_lcon _vsnwprintfmejoras de seguridad, tal y como se describe en Características de_vsnwprintf_lseguridad en el 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 para la salida.

sizeOfBuffer
El tamaño de la buffer salida for. Tamaño en bytes para las funciones que toman char, y palabras para las que toman wchar_t.

count
Número máximo de caracteres que se van a escribir, sin incluir el archivo 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 utilizar al dar formato a la salida.

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

Valor devuelto

El número de caracteres escritos, sin incluir la terminación NULL, o un valor negativo si se produce un error de salida.

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

Observaciones

Cada una de estas funciones toma un puntero a una lista de argumentos, luego formatea y escribe hasta count los caracteres de los datos dados en la memoria a la que apunta buffer y agrega un archivo NULL.

En las compilaciones de depuración, los bytes restantes sizeOfBuffer después de la terminación NULL se rellenan con 'xFE' como se describe en _CrtSetDebugFillThreshold.

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

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

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.
Condición Comportamiento Valor devuelto errno Invoca el controlador de parámetros no válidos
Éxito Escribe los caracteres en el búfer utilizando la cadena de formato especificada Número de caracteres escritos No disponible No
Error de codificación durante el formato Si se procesa el especificador de scadena , S, o Z, se detiene el procesamiento de la especificación de formato. -1 EILSEQ (42) No
Error de codificación durante el formato Si el especificador c de caracteres de procesamiento o C, se omite el carácter no válido. El número de caracteres escritos no se incrementa para el carácter omitido, ni es ningún dato escrito para él. El procesamiento de la especificación de formato continúa después de omitir el especificador con el error de codificación. Número de caracteres escritos, no incluido el terminador NULL. EILSEQ (42) No
buffer == NULL y sizeOfBuffer == 0 y count == 0 No se escriben datos. 0 No disponible No
buffer == NULL y o sizeOfBuffer != 0 bien count != 0 Si la ejecución continúa después de que se ejecute el controlador de parámetros no válidos, establece errno y devuelve un valor negativo. -1 EINVAL (22)
buffer != NULL y sizeOfBuffer == 0 No se escriben datos. Si la ejecución continúa después de que se ejecute el controlador de parámetros no válidos, establece errno y devuelve un valor negativo. -1 EINVAL (22)
buffer != NULL y sizeOfBuffer != 0 y count == 0 Se termina el búfer NULL . -1 No disponible No
count == 0 No escribe ningún dato y devuelve el número de caracteres que se habrían escrito, sin incluir el NULLarchivo . El número de caracteres que se habrían escrito, sin incluir la terminación NULL. No disponible No
count < 0 No seguro: el valor se trata como sin firmar, lo que probablemente crea un valor grande que da lugar a sobrescribir la memoria que sigue al búfer. Número de caracteres escritos, no incluido el terminador NULL. No disponible No
count < sizeOfBuffer y len <= count Todos los datos se escriben y se anexa una terminación NULL . El número de caracteres que se han escrito. No disponible No
count < sizeOfBuffer y len > count Se escriben los primeros count caracteres. -1 No disponible No
count >= sizeOfBuffer y len < sizeOfBuffer Todos los datos se escriben NULLcon una terminación . Número de caracteres escritos, no incluido el terminador NULL. No disponible No
count >= sizeOfBuffer y len >= sizeOfBuffer y count != _TRUNCATE Si la ejecución continúa después de que se ejecute el controlador de parámetros no válidos, establece errno, establece buffer[0] == NULLy devuelve un valor negativo. -1 ERANGE (34)
count == _TRUNCATE y len >= sizeOfBuffer Escribe la mayor parte de la cadena que quepa en buffer, incluido el archivo NULL. -1 No disponible No
count == _TRUNCATE y len < sizeOfBuffer Escribe toda la cadena en buffer con terminación NULL. Número de caracteres escritos. No disponible No
format == NULL No se escriben datos. Si la ejecución continúa después de que se ejecute el controlador de parámetros no válidos, establece errno y devuelve un valor negativo. -1 EINVAL (22)

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

Importante

Asegúrese de que format no es una cadena definida por el usuario. Para obtener más información, consulte Evitar saturaciones del búfer. A partir de Windows 10 versión 2004 (compilación 19041), la familia de funciones printf imprime números de punto flotante que se pueden representar con exactitud según las reglas de redondeo de IEEE 754. En versiones anteriores de Windows, los números de punto flotante que se pueden representar de forma exacta y terminan en "5" siempre se redondean al alza. IEEE 754 indica que deben redondearse al dígito par más próximo (también conocido como "redondeo bancario"). Por ejemplo, tanto printf("%1.0f", 1.5) como printf("%1.0f", 2.5) deben redondearse a 2. Anteriormente, 1,5 se redondearía a 2 y 2,5 a 3. Este cambio solo afecta a los números que se pueden representar de forma exacta. Por ejemplo, 2,35 (que, cuando se representa en memoria, está más cerca de 2,35000000000000008) se sigue redondeando hasta 2,4. El redondeo realizado por estas funciones ahora también respeta el modo de redondeo de punto flotante que fesetround establece. Anteriormente, el redondeo siempre elegía el comportamiento FE_TONEAREST. Este cambio solo afecta a los programas compilados con Visual Studio 2019 versión 16.2 y posteriores. Para usar el comportamiento de redondeo de punto flotante heredado, establezca un vínculo con legacy_stdio_float_rounding.obj.

Nota:

Para asegurarse de que haya espacio para la terminación NULL, asegúrese de que count sea estrictamente menor que la longitud del búfer, o use _TRUNCATE.

En C++, el uso de estas funciones se simplifica mediante sobrecargas de plantillas; Las sobrecargas pueden inferir la longitud del búfer automáticamente (lo que elimina la necesidad de especificar un argumento de tamaño) y pueden reemplazar automáticamente las funciones más antiguas y no seguras por sus homólogas más nuevas y seguras. Para obtener más información, consulte Sobrecargas de plantilla seguras.

Sugerencia

Si obtiene un error externo _vsnprintf_s indefinido y está utilizando Universal C Runtime, agréguelo legacy_stdio_definitions.lib al conjunto de bibliotecas para vincular. Universal C Runtime no exporta esta función directamente y, en su lugar, se define en línea en <stdio.h>. Para obtener más información, vea Información general sobre posibles problemas de actualización y cambios de conformidad de Visual Studio 2015.

Asignaciones de rutinas de texto genérico

Rutina TCHAR.H _UNICODE y _MBCS no definidos _MBCS definido _UNICODE definido
_vsntprintf_s _vsnprintf_s _vsnprintf_s _vsnwprintf_s
_vsntprintf_s_l _vsnprintf_s_l _vsnprintf_s_l _vsnwprintf_s_l

Requisitos

Rutina Encabezado necesario Encabezados opcionales
vsnprintf_s <stdio.h> y <stdarg.h> <varargs.h>*
_vsnprintf_s, _vsnprintf_s_l <stdio.h> y <stdarg.h> <varargs.h>*
_vsnwprintf_s, _vsnwprintf_s_l <stdio.h> o , <wchar.h>y <stdarg.h> <varargs.h>*

* Necesario 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!

Consulte 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