vsprintf, _vsprintf_l, vswprintf, _vswprintf_l, __vswprintf_l

Article
06/09/2015

Ecrit une sortie formattée en utilisant un pointeur vers une liste d'arguments. Des versions plus sécurisées de ces fonctions sont disponibles ; consultez 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

Paramètres

buffer
Emplacement de stockage pour la sortie.
count
Nombre maximal de caractères à stocker, dans la version UNICODE de cette fonction.
format
Spécification de format.
argptr
Pointeur vers la liste d'arguments.
locale
Paramètres régionaux à utiliser.

Valeur de retour

vsprintf et vswprintf retourne le nombre de caractères larges écrits, sans compter le caractère large null de fin, ou une valeur négative si une ereur de sortie arrive. Si buffer ou format est un pointeur null, ces fonctions appelent le gestionnaire de paramètres non valides, comme décrit dans Validation de paramètre. Si l'exécution est autorisée à se poursuivre, ces fonctions retournent -1 et attribuent à errno la valeur EINVAL.

Pour plus d'informations sur ces codes d'erreur et autres, consultez _doserrno, errno, _sys_errlist et _sys_nerr.

Notes

Chacune de ces fonctions prend un pointeur comme liste d'arguments, et le forme ensuite puis écrit les données dans la mémoire pointée par buffer.

Les versions de ces fonctions avec le suffixe _l sont identiques, sauf qu'elles utilisent les paramètres régionaux passés au lieu des paramètres régionaux du thread actuel.

Note de sécurité
Avec vsprintf, il n'existe aucun moyen ici de limiter le nombre de caractères écrits, ce qui signifie que le code utilisant cette fonction risque un dépassement de mémoire tampon.Utilisez vsnprintf à la place, ou appelez _vscprintf pour déterminer quelle largeur de mémoire tampon est nécessaire.Assurez-vous également que format n'est pas une chaîne définie par l'utilisateur.Pour plus d'informations, consultez Solutions contre les dépassements de mémoire tampon.

Avec vsprintf, il n'existe aucun moyen ici de limiter le nombre de caractères écrits, ce qui signifie que le code utilisant cette fonction risque un dépassement de mémoire tampon.Utilisez vsnprintf à la place, ou appelez _vscprintf pour déterminer quelle largeur de mémoire tampon est nécessaire.Assurez-vous également que format n'est pas une chaîne définie par l'utilisateur.Pour plus d'informations, consultez Solutions contre les dépassements de mémoire tampon.

vswprintf est conforme à la norme C ISO, qui requiert le deuxième paramètre, count, de type size_t. Pour forcer l'ancien comportement inhabituel, définissez _CRT_NON_CONFORMING_SWPRINTFS.. L'ancien comportement peut être supprimé dans une version future, donc le code doit être modifié pour utiliser le nouveau comportement compatible.

En C++, ces fonctions ont des surcharges de modèle qui appellent les équivalents plus récents et sécurisés de ces fonctions. Pour plus d'informations, consultez Sécuriser les surcharges de modèle.

Mappages de routines de texte générique

Routine TCHAR.H	_UNICODE & _MBCS non définis	_MBCS défini	_UNICODE défini
_vstprintf	vsprintf	vsprintf	vswprintf
_vstprintf_l	_vsprintf_l	_vsprintf_l	_vswprintf_l

Configuration requise

Routine	En-tête requis	En-têtes facultatifs
vsprintf, _vsprintf_l	<stdio.h> et <stdarg.h>	<varargs.h>*
vswprintf, _vswprintf_l	<stdio.h> ou <wchar.h>, et <stdarg.h>	<varargs.h>*

* Requis pour la compatibilité UNIX V.

Pour plus d'informations sur la compatibilité, consultez Compatibilité dans l'introduction.

Exemple

// 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" );
}