scanf, fscanf, sscanf, scanf_s, fscanf_s, sscanf_s

From cppreference.net

< c ‎ | io

Défini dans l'en-tête `<stdio.h>`
	(1)
int scanf ( const char * format, ... ) ;			(jusqu'à C99)
int scanf ( const char * restrict format, ... ) ;			(depuis C99)
		(2)
int fscanf ( FILE * stream, const char * format, ... ) ;				(jusqu'à C99)
int fscanf ( FILE * restrict stream, const char * restrict format, ... ) ;				(depuis C99)
			(3)
int sscanf ( const char * buffer, const char * format, ... ) ;					(jusqu'à C99)
int sscanf ( const char * restrict buffer, const char * restrict format, ... ) ;					(depuis C99)
int scanf_s ( const char * restrict format, ... ) ;				(4)	(depuis C11)
int fscanf_s ( FILE * restrict stream, const char * restrict format, ... ) ;				(5)	(depuis C11)
int sscanf_s ( const char * restrict buffer, const char * restrict format, ... ) ;				(6)	(depuis C11)

Lit les données à partir de diverses sources, les interprète selon le format et stocke les résultats dans les emplacements donnés.

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

. Atteindre la fin de la chaîne équivaut à atteindre la condition de fin de fichier pour


        fscanf

4-6) Identique à (1-3) , sauf que % c , % s , et % [ attendent chacun deux arguments (le pointeur habituel et une valeur de type rsize_t indiquant la taille du tableau récepteur, qui peut être 1 lors de la lecture avec % c dans un seul caractère) et sauf que les erreurs suivantes sont détectées à l'exécution et appellent la fonction gestionnaire de contraintes actuellement installée :

l'un des arguments de type pointeur est un pointeur nul
format , stream , ou buffer est un pointeur nul
le nombre de caractères qui seraient écrits par % c , % s , ou % [ , plus le caractère nul de fin, dépasserait le deuxième argument ( rsize_t ) fourni pour chacun de ces spécificateurs de conversion
optionnellement, toute autre erreur détectable, telle qu'un spécificateur de conversion inconnu

Comme pour toutes les fonctions à vérification des limites,


          scanf_s


          fscanf_s

, et


          sscanf_s

ne sont garantis d'être disponibles que si __STDC_LIB_EXT1__ est défini par l'implémentation et si l'utilisateur définit __STDC_WANT_LIB_EXT1__ à la constante entière 1 avant d'inclure <stdio.h> .

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

caractère introductif % .

(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 diffère 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 C99→		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 caractères 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 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 *	intmax_t * ou uintmax_t *	size_t *	ptrdiff_t *	N/A
`i`	Correspond à un entier . Le format du nombre est le même que celui attendu par 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 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 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 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` (C99) `A` (C99) `e` `E` `f` `F` (C99) `g` `G`	Correspond à un nombre à virgule flottante . Le format du nombre est le même que celui attendu par 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` et les fonctions apparentées doivent 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 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 c'est 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 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 en caractères larges comme en appelant mbrtowc avec un objet 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 gets . Les spécifications de conversion correctes pour les types entiers de largeur fixe ( int8_t , etc.) sont définies dans l'en-tête `<inttypes.h>` (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 ; ce qui 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.

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

Valeur de retour

1-3) Nombre d'arguments de réception correctement assignés (qui peut être zéro dans le cas où un échec de correspondance survient avant que le premier argument de réception ne soit assigné), ou EOF si une défaillance d'entrée se produit avant que le premier argument de réception ne soit assigné.

4-6) Identique à (1-3) , sauf que EOF est également retourné en cas de violation de contrainte d'exécution.

Complexité

Non garanti. Notamment, certaines implémentations de sscanf sont $O(N)$ , où N = strlen ( buffer ) [1] .

Notes

Étant donné que la plupart des spécificateurs de conversion consomment d'abord tous les espaces blancs consécutifs, un code tel que

scanf("%d", &a);
scanf("%d", &b);

lira deux entiers saisis sur des lignes différentes (le second % d consommera le saut de ligne laissé par le premier) ou sur la même ligne, séparés par des espaces ou des tabulations (le second % d consommera les espaces ou les tabulations).

The conversion specifiers that do not consume leading whitespace, such as % c , can be made to do so by using a whitespace character in the format string:

scanf("%d", &a);
scanf(" %c", &c); // consommer tous les espaces consécutifs après %d, puis lire un caractère

Exemple

Exécuter ce code

#define __STDC_WANT_LIB_EXT1__ 1
#include <stdio.h>
#include <stddef.h>
#include <locale.h>
int main(void)
{
    int i, j;
    float x, y;
    char str1[10], str2[4];
    wchar_t warr[2];
    setlocale(LC_ALL, "en_US.utf8");
    char input[] = "25 54.32E-1 Thompson 56789 0123 56ß水";
    /* analyse comme suit :
       %d : un entier
       %f : une valeur en virgule flottante
       %9s : une chaîne d'au plus 9 caractères non-blancs
       %2d : un entier à deux chiffres (chiffres 5 et 6)
       %f : une valeur en virgule flottante (chiffres 7, 8, 9)
       %*d : un entier qui n'est stocké nulle part
       ' ' : tous les espaces blancs consécutifs
       %3[0-9] : une chaîne d'au plus 3 chiffres décimaux (chiffres 5 et 6)
       %2lc : deux caractères larges, utilisant la conversion multioctet vers large */
    int ret = sscanf(input, "%d%f%9s%2d%f%*d %3[0-9]%2lc",
                     &i, &x, str1, &j, &y, str2, warr);
    printf("Converted %d fields:\n"
           "i = %d\n"
           "x = %f\n"
           "str1 = %s\n"
           "j = %d\n"
           "y = %f\n"
           "str2 = %s\n"
           "warr[0] = U+%x\n"
           "warr[1] = U+%x\n",
           ret, i, x, str1, j, y, str2, warr[0], warr[1]);
#ifdef __STDC_LIB_EXT1__
    int n = sscanf_s(input, "%d%f%s", &i, &x, str1, (rsize_t)sizeof str1);
    // écrit 25 dans i, 5.432 dans x, les 9 octets "Thompson\0" dans str1, et 3 dans n.
#endif
}

Sortie possible :

Converted 7 fields:
i = 25
x = 5.432000
str1 = Thompson
j = 56
y = 789.000000
str2 = 56
warr[0] = U+df
warr[1] = U+6c34

Références

Norme C17 (ISO/CEI 9899:2018) :

7.21.6.2 La fonction fscanf (p : 231-236)

7.21.6.4 La fonction scanf (p : 236-237)

7.21.6.7 La fonction sscanf (p : 238-239)

K.3.5.3.2 La fonction fscanf_s (p : 430-431)

K.3.5.3.4 La fonction scanf_s (p : 432)

K.3.5.3.7 La fonction sscanf_s (p : 433)

Norme C11 (ISO/CEI 9899:2011) :

7.21.6.2 La fonction fscanf (p: 317-324)

7.21.6.4 La fonction scanf (p: 325)

7.21.6.7 La fonction sscanf (p: 326)

K.3.5.3.2 La fonction fscanf_s (p: 592-593)

K.3.5.3.4 La fonction scanf_s (p: 594)

K.3.5.3.7 La fonction sscanf_s (p: 596)

Norme C99 (ISO/CEI 9899:1999) :

7.19.6.2 La fonction fscanf (p : 282-289)

7.19.6.4 La fonction scanf (p : 290)

7.19.6.7 La fonction sscanf (p : 291)

Norme C89/C90 (ISO/CEI 9899:1990) :

4.9.6.2 La fonction fscanf

4.9.6.4 La fonction scanf

4.9.6.6 La fonction sscanf

Voir aussi

vscanf vfscanf vsscanf vscanf_s vfscanf_s vsscanf_s (C99) (C99) (C99) (C11) (C11) (C11)	lit une entrée formatée depuis stdin , un flux de fichier ou un tampon en utilisant une liste d'arguments variables (fonction)
fgets	obtient une chaîne de caractères depuis un flux de fichier (fonction)
printf fprintf sprintf snprintf printf_s fprintf_s sprintf_s snprintf_s (C99) (C11) (C11) (C11) (C11)	imprime une sortie formatée vers stdout , un flux de fichier ou un tampon (fonction)
Documentation C++ pour scanf , fscanf , sscanf

Compiler support
Language
Headers
Type support
Program utilities
Variadic function support
Error handling
Dynamic memory management
Strings library
Algorithms
Numerics
Date and time utilities
Input/output support
Localization support
Concurrency support (C11)
Technical Specifications
Symbol index

cppreference.net

Namespaces

Variants