sprintf, _sprintf_l, swprintf, _swprintf_l, __swprintf_l

Artículo
07/21/2015

Escribir datos con formato en una cadena. Hay disponibles versiones más seguras de algunas de estas funciones; vea sprintf_s, _sprintf_s_l, swprintf_s, _swprintf_s_l. Las versiones seguras de swprintf y de _swprintf_l no toman un parámetro count.

int sprintf(
   char *buffer,
   const char *format [,
   argument] ... 
);
int _sprintf_l(
   char *buffer,
   const char *format,
   locale_t locale [,
   argument] ... 
);
int swprintf(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format [,
   argument]...
);
int _swprintf_l(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   locale_t locale [,
   argument] ... 
);
int __swprintf_l(
   wchar_t *buffer,
   const wchar_t *format,
   locale_t locale [,
   argument] ... 
);
template <size_t size>
int sprintf(
   char (&buffer)[size],
   const char *format [,
   argument] ... 
); // C++ only
template <size_t size>
int _sprintf_l(
   char (&buffer)[size],
   const char *format,
   locale_t locale [,
   argument] ... 
); // C++ only
template <size_t size>
int swprintf(
   wchar_t (&buffer)[size],
   const wchar_t *format [,
   argument]...
); // C++ only
template <size_t size>
int _swprintf_l(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   locale_t locale [,
   argument] ... 
); // C++ only

Parámetros

buffer
Ubicación de almacenamiento para los resultados
count
Número máximo de caracteres que se van a almacenar en la versión Unicode de esta función.
format
Cadena de control de formato
argument
Argumentos opcionales
locale
Configuración regional que se va a usar.

Para obtener más información, vea Especificaciones 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, se invoca el controlador no válido de parámetro, tal y como se describe en Validación de parámetros. Si la ejecución puede continuar, estas funciones devuelven -1 y establecen errno en EINVAL.

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

Comentarios

La función sprintf 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.

Nota sobre la seguridad
Al utilizar sprintf, no hay forma de limitar el número de caracteres escritos, lo que significa que el código que utiliza sprintf es susceptible de saturaciones del búfer.Considere la posibilidad de usar la función _snprintf relacionada, que especifica un número máximo de caracteres que se van a escribir en buffer, o _scprintf para determinar el tamaño requerido de un búfer.Además, asegúrese de que format no es una cadena definida por el usuario.

Al utilizar sprintf, no hay forma de limitar el número de caracteres escritos, lo que significa que el código que utiliza sprintf es susceptible de saturaciones del búfer.Considere la posibilidad de usar la función _snprintf relacionada, que especifica un número máximo de caracteres que se van a escribir en buffer, o _scprintf para determinar el tamaño requerido de un búfer.Además, asegúrese de que format no es una cadena definida por el usuario.

swprintf es una versión con caracteres anchos de sprintf; los argumentos de puntero a swprintf son cadenas de carácter ancho. La detección de errores de codificación en swprintf puede diferir de la de sprintf. swprintf y fwprintf se comportan exactamente igual excepto que swprintf escribe la salida en una cadena y no en un destino de tipo FILE y swprintf requiere el parámetro count para especificar el número máximo de caracteres que se escriban. 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.

swprintf se ajusta a ISO C estándar, que requiere el segundo parámetro, count, de tipo size_t. Para forzar el comportamiento antiguo no estándar, defina _CRT_NON_CONFORMING_SWPRINTFS. En una versión posterior, el comportamiento antiguo se puede quitar, por lo que el código se debe cambiar para 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
_stprintf	sprintf	sprintf	swprintf
_stprintf_l	_sprintf_l	_sprintf_l	__swprintf_l

Requisitos

Rutina	Encabezado necesario
sprintf, _sprintf_l	<stdio.h>
swprintf, _swprintf_l	<stdio.h> o <wchar.h>

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

Ejemplo

// crt_sprintf.c
// compile with: /W3
// This program uses sprintf 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( buffer,     "   String:    %s\n", s ); // C4996
   j += sprintf( buffer + j, "   Character: %c\n", c ); // C4996
   j += sprintf( buffer + j, "   Integer:   %d\n", i ); // C4996
   j += sprintf( buffer + j, "   Real:      %f\n", fp );// C4996
   // Note: sprintf is deprecated; consider using sprintf_s instead

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

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

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