sprintf_s, _sprintf_s_l, swprintf_s, _swprintf_s_l

Escribir datos con formato en una cadena. Estas funciones son versiones de sprintf, _sprintf_l, swprintf, _swprintf_lcon __swprintf_l mejoras de seguridad, como se describe en Características de seguridad de CRT.

Sintaxis

int sprintf_s(
   char *buffer,
   size_t sizeOfBuffer,
   const char *format,
   ...
);
int _sprintf_s_l(
   char *buffer,
   size_t sizeOfBuffer,
   const char *format,
   _locale_t locale,
   ...
);
int swprintf_s(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   const wchar_t *format,
   ...
);
int _swprintf_s_l(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   const wchar_t *format,
   _locale_t locale,
   ...
);
template <size_t size>
int sprintf_s(
   char (&buffer)[size],
   const char *format,
   ...
); // C++ only
template <size_t size>
int swprintf_s(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   ...
); // C++ only

Parámetros

buffer
Ubicación de almacenamiento para los resultados

sizeOfBuffer
Número máximo de caracteres que se pueden almacenar.

format
Cadena de control de formato

...
Argumentos opcionales a los que dar formato

locale
Configuración regional que se va a usar.

Para obtener más información, vea Sintaxis de especificación de formato.

Valor devuelto

El número de caracteres escrito, o - 1 si se ha producido un error. Si buffer o format es un puntero null, sprintf_s y swprintf_s y devuelven -1 y establecen errno como EINVAL.

sprintf_s devuelve el número de bytes almacenados en buffer, sin contar el carácter null de terminación. swprintf_s devuelve el número de caracteres anchos almacenados en buffer, sin contar el carácter ancho final null.

Comentarios

La función sprintf_s da formato y almacena una serie de caracteres y valores en buffer. Cada argument (si existe) se convierte y sale según la especificación de formato correspondiente de format. El formato consta de caracteres ordinarios y tiene el mismo formato y función que el argumento format para printf. Un carácter null se anexa después del último carácter escrito. Si la copia tiene lugar entre cadenas que se superponen, el comportamiento es indefinido.

Una gran diferencia entre sprintf_s y sprintf es que sprintf_s comprueba la cadena de formato de los caracteres de formato válidos, mientras que sprintf solo comprueba si la cadena de formato o el búfer son punteros de NULL . Si se produce un error en cualquiera de las comprobaciones, se invoca el controlador de parámetros no válidos, como se describe en Validación de parámetros. Si la ejecución puede continuar, la función devuelve -1 y establece errno en EINVAL.

Otra diferencia principal entre sprintf_s y sprintf es que sprintf_s toma un parámetro de longitud que especifica el tamaño del búfer de salida en caracteres. Si el búfer es demasiado pequeño para el texto con formato, incluido el elemento null final, el búfer se establece en una cadena vacía colocando un carácter null en buffer[0], y se invoca el controlador de parámetros no válidos. A diferencia de _snprintf, sprintf_s garantiza que el búfer termine en un elemento null (a menos que el tamaño de búfer sea cero).

swprintf_s es una versión con caracteres anchos de sprintf_s; los argumentos de puntero a swprintf_s son cadenas de carácter ancho. La detección de errores de codificación en swprintf_s puede diferir de la detección en sprintf_s. 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.

En C++, las sobrecargas de plantilla simplifican el uso de estas funciones. Las sobrecargas pueden deducir automáticamente la longitud del búfer, lo que elimina la necesidad de especificar un argumento size. Además, pueden reemplazar automáticamente las funciones antiguas y no seguras con homólogos más recientes y seguros. Para obtener más información, consulte Sobrecargas de plantillas seguras.

Hay versiones de sprintf_s que ofrecen más control sobre lo que sucede si el búfer es demasiado pequeño. Para obtener más información, vea _snprintf_s, _snprintf_s_l, _snwprintf_s, _snwprintf_s_l.

Importante

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".

Asignaciones de rutinas de texto genérico

Rutina TCHAR.H	_UNICODE y _MBCS no definidos	_MBCS definido	_UNICODE definido
_stprintf_s	sprintf_s	sprintf_s	swprintf_s
_stprintf_s_l	_sprintf_s_l	_sprintf_s_l	_swprintf_s_l

Requisitos

Routine	Encabezado necesario
sprintf_s, _sprintf_s_l	C: <stdio.h> C++: <cstdio> o <stdio.h>
swprintf_s, _swprintf_s_l	C: <stdio.h> o <wchar.h> C++: <cstdio>, <cwchar>, <stdio.h> o <wchar.h>

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

Ejemplo: Uso de sprintf_s para dar formato a los datos

// crt_sprintf_s.c
// This program uses sprintf_s to format various
// data and place them in the string named buffer.
//

#include <stdio.h>

int main( void )
{
   char  buffer[200], s[] = "computer", c = 'l';
   int   i = 35, j;
   float fp = 1.7320534f;

   // Format and print various data:
   j  = sprintf_s( buffer, 200,     "   String:    %s\n", s );
   j += sprintf_s( buffer + j, 200 - j, "   Character: %c\n", c );
   j += sprintf_s( buffer + j, 200 - j, "   Integer:   %d\n", i );
   j += sprintf_s( buffer + j, 200 - j, "   Real:      %f\n", fp );

   printf_s( "Output:\n%s\ncharacter count = %d\n", buffer, j );
}

Output:
   String:    computer
   Character: l
   Integer:   35
   Real:      1.732053

character count = 79

Ejemplo: Control de códigos de error

// crt_swprintf_s.c
// wide character example
// also demonstrates swprintf_s returning error code
#include <stdio.h>

int main( void )
{
   wchar_t buf[100];
   int len = swprintf_s( buf, 100, L"%s", L"Hello world" );
   printf( "wrote %d characters\n", len );
   len = swprintf_s( buf, 100, L"%s", L"Hello\xffff world" );
   // swprintf_s fails because string contains WEOF (\xffff)
   printf( "wrote %d characters\n", len );
}

wrote 11 characters
wrote -1 characters

Consulte también

E/S de secuencia
fprintf, _fprintf_l, fwprintf, _fwprintf_l
printf, _printf_l, wprintf, _wprintf_l
sprintf, _sprintf_l, swprintf, _swprintf_l, __swprintf_l
scanf, _scanf_l, wscanf, _wscanf_l
sscanf, _sscanf_l, swscanf, _swscanf_l
Funciones vprintf