Namespaces
Variants

std:: vscanf, std:: vfscanf, std:: vsscanf

From cppreference.net
< cpp ‎ | io ‎ | c
Défini dans l'en-tête <cstdio>
int vscanf ( const char * format, std :: va_list vlist ) ;
(1) (depuis C++11)
int vfscanf ( std:: FILE * stream, const char * format, std :: va_list vlist ) ;
(2) (depuis C++11)
int vsscanf ( const char * buffer, const char * format, std :: va_list vlist ) ;
(3) (depuis C++11)

Lit les données depuis diverses sources, les interprète selon le format et stocke les résultats dans les emplacements définis par vlist .

1) Lit les données depuis stdin .
2) Lit les données du flux de fichier stream .
3) Lit les données de la chaîne de caractères terminée par un caractère nul buffer .

Table des matières

Paramètres

stream - flux de fichier d'entrée à lire
buffer - pointeur vers une chaîne de caractères terminée par un caractère nul à lire
format - pointeur vers une chaîne de caractères terminée par un caractère nul spécifiant comment lire l'entrée
vlist - liste d'arguments variables contenant les arguments de réception.


La chaîne de format se compose de

  • caractères multioctets non blancs sauf % : chaque caractère de ce type dans la chaîne de format consomme exactement un caractère identique du flux d'entrée, ou provoque l'échec de la fonction si le caractère suivant dans le flux n'est pas égal.
  • caractères d'espacement : tout caractère d'espacement unique dans la chaîne de format consomme tous les caractères d'espacement consécutifs disponibles en entrée (déterminés comme en appelant std::isspace dans une boucle). Notez qu'il n'y a aucune différence entre " \n " , " " , " \t \t " , ou tout autre espacement dans la chaîne de format.
  • spécifications de conversion. Chaque spécification de conversion a le format suivant :
  • introduction % caractère.
  • (optionnel) caractère de suppression d'assignation * . Si cette option est présente, la fonction n'assigne pas le résultat de la conversion à aucun argument récepteur.
  • (optionnel) nombre entier (supérieur à zéro) qui spécifie la largeur maximale du champ , c'est-à-dire le nombre maximum de caractères que la fonction est autorisée à consommer lors de la conversion spécifiée par la spécification de conversion actuelle. Notez que % s et % [ peuvent entraîner un dépassement de tampon si la largeur n'est pas fournie.
  • (optionnel) modificateur de longueur qui spécifie la taille de l'argument récepteur, c'est-à-dire le type de destination réel. Cela affecte la précision de conversion et les règles de dépassement de capacité. Le type de destination par défaut est différent pour chaque type de conversion (voir le tableau ci-dessous).
  • spécificateur de format de conversion.

Les spécificateurs de format suivants sont disponibles :

Spécificateur
de conversion
Explication Type d'argument
attendu
Modificateur de longueur→ hh h aucun l ll j z t L
Disponible uniquement depuis C++11→ Oui Oui Oui Oui Oui
%
Correspond au caractère littéral % .
N/A N/A N/A N/A N/A N/A N/A N/A N/A
c

Correspond à un caractère ou une séquence de caractères .

  • Si un spécificateur de largeur est utilisé, correspond exactement à width caractères (l'argument doit être un pointeur vers un tableau avec suffisamment d'espace).
  • Contrairement à %s et %[, n'ajoute pas le caractère nul au tableau.
N/A N/A
char *
wchar_t *
N/A N/A N/A N/A N/A
s

Correspond à une séquence de caractères non-blancs (une chaîne ).

  • Si le spécificateur de largeur est utilisé, correspond jusqu'à width ou jusqu'au premier caractère blanc, selon ce qui apparaît en premier.
  • Stocke toujours un caractère nul en plus des caractères correspondants (donc le tableau d'argument doit avoir de la place pour au moins width+1 caractères).
[ set  ]

Correspond à une séquence non vide de caractères de l'ensemble set de caractères.

  • Si le premier caractère de l'ensemble est ^ , alors tous les caractères non inclus dans l'ensemble sont correspondants.
  • Si l'ensemble commence par ] ou ^] , alors le caractère ] est également inclus dans l'ensemble.
  • Il est défini par l'implémentation si le caractère - en position non initiale dans le scanset peut indiquer un intervalle, comme dans [0-9] .
  • Si le spécificateur de largeur est utilisé, correspond uniquement jusqu'à width .
  • Stocke toujours un caractère nul en plus des caractères correspondants (donc le tableau d'argument doit avoir de la place pour au moins width+1 caractères).
d

Correspond à un entier décimal .

  • Le format du nombre est le même que celui attendu par std::strtol avec la valeur 10 pour l'argument base .
signed char * ou unsigned char *
signed short * ou unsigned short *
signed int * ou unsigned int *
signed long * ou unsigned long *
signed long long * ou unsigned long long *
N/A
i

Correspond à un entier .

  • Le format du nombre est le même que celui attendu par std::strtol avec la valeur 0 pour l'argument base (la base est déterminée par les premiers caractères analysés).
u

Correspond à un entier décimal non signé .

  • Le format du nombre est le même que celui attendu par std::strtoul avec la valeur 10 pour l'argument base .
o

Correspond à un entier octal non signé .

  • Le format du nombre est le même que celui attendu par std::strtoul avec la valeur 8 pour l'argument base .
x
X

Correspond à un entier hexadécimal non signé .

  • Le format du nombre est le même que celui attendu par std::strtoul avec la valeur 16 pour l'argument base .
n

Retourne le nombre de caractères lus jusqu'à présent .

  • Aucune entrée n'est consommée. N'incrémente pas le compteur d'assignation.
  • Si le spécificateur a l'opérateur de suppression d'assignation défini, le comportement est indéfini.
a (C++11)
A (C++11)
e
E
f
F (C++11)
g
G

Correspond à un nombre à virgule flottante .

  • Le format du nombre est le même que celui attendu par std::strtof .
N/A N/A
float *
double *
N/A N/A N/A N/A
long double *
p

Correspond à une séquence de caractères définie par l'implémentation représentant un pointeur .

  • printf famille de fonctions devrait produire la même séquence en utilisant le %p spécificateur de format.
N/A N/A
void **
N/A N/A N/A N/A N/A N/A
Notes

Pour chaque spécificateur de conversion autre que n , la plus longue séquence de caractères d'entrée qui ne dépasse pas la largeur de champ spécifiée et qui correspond exactement à ce que le spécificateur de conversion attend ou qui est un préfixe d'une séquence qu'il attendrait, est ce qui est consommé depuis le flux. Le premier caractère, s'il existe, après cette séquence consommée reste non lu. Si la séquence consommée a une longueur nulle ou si la séquence consommée ne peut pas être convertie comme spécifié ci-dessus, un échec de correspondance se produit, sauf si la fin de fichier, une erreur d'encodage ou une erreur de lecture a empêché la lecture depuis le flux, auquel cas il s'agit d'un échec d'entrée.

Tous les spécificateurs de conversion autres que [ , c , et n consomment et ignorent tous les caractères d'espacement initiaux (déterminés comme en appelant std::isspace ) avant de tenter d'analyser l'entrée. Ces caractères consommés ne comptent pas dans la largeur de champ maximale spécifiée.

Les spécificateurs de conversion lc , ls , et l [ effectuent une conversion de caractères multi-octets vers des caractères larges comme en appelant std::mbrtowc avec un objet std::mbstate_t initialisé à zéro avant la conversion du premier caractère.

Les spécificateurs de conversion s et [ stockent toujours le terminateur nul en plus des caractères correspondants. La taille du tableau de destination doit être au moins supérieure d'un à la largeur de champ spécifiée. L'utilisation de % s ou % [ , sans spécifier la taille du tableau de destination, est aussi dangereuse que std::gets .

Les spécifications de conversion correctes pour les types entiers de largeur fixe ( std::int8_t , etc.) sont définies dans l'en-tête <cinttypes> (bien que SCNdMAX , SCNuMAX , etc. soient synonymes de % jd , % ju , etc.).

Il y a un point de séquence après l'action de chaque spécificateur de conversion ; cela permet de stocker plusieurs champs dans la même variable "réceptacle".

Lors de l'analyse d'une valeur flottante incomplète se terminant par l'exposant sans chiffres, comme l'analyse de "100er" avec le spécificateur de conversion % f , la séquence "100e" (le plus long préfixe d'un nombre flottant potentiellement valide) est consommée, résultant en une erreur de correspondance (la séquence consommée ne peut pas être convertie en nombre flottant), avec "r" restant. Certaines implémentations existantes ne suivent pas cette règle et reviennent en arrière pour ne consommer que "100" , laissant "er" , par exemple, bogue glibc 1765 .

Si une spécification de conversion est invalide, le comportement est indéfini.

Valeur de retour

Nombre d'arguments lus avec succès, ou EOF en cas d'échec.

Notes

Toutes ces fonctions invoquent va_arg au moins une fois, la valeur de arg est indéterminée après le retour. Ces fonctions n'invoquent pas va_end , et cela doit être effectué par l'appelant.

Exemple

#include <cstdarg>
#include <cstdio>
#include <iostream>
#include <stdexcept>
void checked_sscanf(int count, const char* buf, const char *fmt, ...)
{
    std::va_list ap;
    va_start(ap, fmt);
    if (std::vsscanf(buf, fmt, ap) != count)
        throw std::runtime_error("parsing error");
    va_end(ap);
}
int main()
{
    try
    {
        int n, m;
        std::cout << "Analyse de '1 2'... ";
        checked_sscanf(2, "1 2", "%d %d", &n, &m);
        std::cout << "succès\n";
        std::cout << "Analyse de '1 a'... ";
        checked_sscanf(2, "1 a", "%d %d", &n, &m);
        std::cout << "succès\n";
    }
    catch (const std::exception& e)
    {
        std::cout << e.what() << '\n';
    }
}

Sortie :

Analyse de '1 2'... succès
Analyse de '1 a'... parsing error

Voir aussi

lit une entrée formatée depuis stdin , un flux de fichier ou un tampon
(fonction)
imprime une sortie formatée vers stdout , un flux de fichier ou un tampon
en utilisant une liste d'arguments variable
(fonction)
Documentation C pour vscanf , vfscanf , vsscanf