Namespaces
Variants

vscanf, vfscanf, vsscanf, vscanf_s, vfscanf_s, vsscanf_s

From cppreference.net
< c ‎ | io
C
File input/output
Types and objects
Functions
File access
Unformatted input/output
Formatted input
vscanf vfscanf vsscanf vscanf_s vfscanf_s vsscanf_s
(C99) (C99) (C99) (C11) (C11) (C11)
(C99) (C99) (C99) (C11) (C11) (C11)
Definiert in Header <stdio.h>
int vscanf ( const char * restrict format, va_list vlist ) ;
(1) (seit C99)
int vfscanf ( FILE * restrict stream, const char * restrict format,
va_list vlist ) ;
(2) (seit C99)
int vsscanf ( const char * restrict buffer, const char * restrict format,
va_list vlist ) ;
(3) (seit C99)
int vscanf_s ( const char * restrict format, va_list vlist ) ;
(4) (seit C11)
int vfscanf_s ( FILE * restrict stream, const char * restrict format,
va_list vlist ) ;
(5) (seit C11)
int vsscanf_s ( const char * restrict buffer, const char * restrict format,
va_list vlist ) ;
(6) (seit C11)

Liest Daten aus verschiedenen Quellen, interpretiert sie gemäß format und speichert die Ergebnisse an den durch vlist definierten Speicherorten.

1) Liest die Daten von stdin
2) Liest die Daten aus dem Dateistrom stream
3) Liest die Daten aus der nullterminierten Zeichenkette buffer . Das Erreichen des Endes der Zeichenkette entspricht dem Erreichen der Dateiende-Bedingung für fscanf
4-6) Gleich wie (1-3) , außer dass % c , % s , und % [ Konvertierungsspezifizierer jeweils zwei Argumente erwarten (den üblichen Zeiger und einen Wert vom Typ rsize_t , der die Größe des Empfangsarrays angibt, die 1 sein kann beim Lesen mit %c in ein einzelnes char) und außer dass die folgenden Fehler zur Laufzeit erkannt werden und die aktuell installierte Constraint-Handler -Funktion aufrufen:
  • eines der Argumente vom Zeigertyp ist ein Nullzeiger
  • format , stream , oder buffer ist ein Nullzeiger
  • die Anzahl der Zeichen, die durch %c, %s oder %[ geschrieben würden, plus das abschließende Nullzeichen, das zweite (rsize_t) Argument überschreiten würden, das für jeden dieser Konvertierungsspezifizierer bereitgestellt wird
  • optional jeder andere erkennbare Fehler, wie unbekannter Konvertierungsspezifizierer
Wie bei allen grenzprüfenden Funktionen sind vscanf_s , vfscanf_s , und vsscanf_s nur garantiert verfügbar, wenn __STDC_LIB_EXT1__ durch die Implementierung definiert ist und wenn der Benutzer __STDC_WANT_LIB_EXT1__ auf die Integer-Konstante 1 setzt, bevor <stdio.h> eingebunden wird.

Inhaltsverzeichnis

Parameter

stream - Eingabedateistream, von dem gelesen wird
buffer - Zeiger auf einen nullterminierten Zeichenstring, von dem gelesen wird
format - Zeiger auf einen nullterminierten Zeichenstring, der angibt, wie die Eingabe gelesen wird
vlist - Variable Argumentenliste, die die empfangenden Argumente enthält


Die Format -Zeichenkette besteht aus

  • Nicht-Leerzeichen-Mehrbytezeichen außer % : Jedes solche Zeichen im Formatstring konsumiert genau ein identisches Zeichen aus dem Eingabestrom oder führt zum Fehlschlagen der Funktion, falls das nächste Zeichen im Strom nicht gleich ist.
  • Leerzeichenzeichen: Jedes einzelne Leerzeichenzeichen im Formatstring konsumiert alle verfügbaren aufeinanderfolgenden Leerzeichenzeichen aus der Eingabe (bestimmt wie durch wiederholten Aufruf von isspace ). Beachten Sie, dass es keinen Unterschied zwischen " \n " , " " , " \t \t " oder anderen Leerzeichen im Formatstring gibt.
  • Konvertierungsspezifikationen. Jede Konvertierungsspezifikation hat folgendes Format:
  • Einleitendes % Zeichen.
  • (optional) unterdrückendes Zuweisungszeichen * . Wenn diese Option vorhanden ist, weist die Funktion das Ergebnis der Konvertierung keinem empfangenden Argument zu.
  • (optional) Ganzzahl (größer als Null), die die maximale Feldbreite angibt, also die maximale Anzahl von Zeichen, die die Funktion bei der Durchführung der durch die aktuelle Konvertierungsspezifikation angegebenen Konvertierung verarbeiten darf. Beachten Sie, dass % s und % [ zu einem Pufferüberlauf führen können, wenn die Breite nicht angegeben wird.
  • (optional) Längenmodifikator der die Größe des empfangenden Arguments angibt, also den eigentlichen Zieltyp. Dies beeinflusst die Konvertierungsgenauigkeit und Überlaufregeln. Der Standardzieltyp ist für jeden Konvertierungstyp unterschiedlich (siehe Tabelle unten).
  • Konvertierungsformat-Spezifizierer.

Die folgenden Formatbezeichner sind verfügbar:

Konvertierungs-
spezifizierer 		Erklärung Erwarteter
Argumenttyp
Längenmodifikator→ hh h keine l ll j z t L
Nur verfügbar seit C99→ Ja Ja Ja Ja Ja
%
Entspricht dem Literal % .
N/A N/A N/A N/A N/A N/A N/A N/A N/A
c

Entspricht einem Zeichen oder einer Folge von Zeichen .

  • Wenn eine Breitenangabe verwendet wird, entspricht es genau width Zeichen (das Argument muss ein Zeiger auf ein Array mit ausreichend Platz sein).
  • Im Gegensatz zu %s und %[ wird kein Nullzeichen an das Array angehängt.
N/A N/A
char *
wchar_t *
N/A N/A N/A N/A N/A
s

Entspricht einer Folge von Nicht-Leerzeichen (einer Zeichenkette ).

  • Wenn ein Breitenbezeichner verwendet wird, entspricht es bis zu Breite oder bis zum ersten Leerzeichen, je nachdem, was zuerst auftritt.
  • Speichert immer ein Nullzeichen zusätzlich zu den übereinstimmenden Zeichen (daher muss das Argument-Array Platz für mindestens Breite+1 Zeichen haben).
[ set  ]

Stimmt mit einer nicht-leeren Zeichenfolge aus dem set von Zeichen überein.

  • Wenn das erste Zeichen des Sets ^ ist, werden alle Zeichen außerhalb des Sets gematcht.
  • Wenn das Set mit ] oder ^] beginnt, wird das ] -Zeichen ebenfalls in das Set aufgenommen.
  • Es ist implementierungsdefiniert, ob das Zeichen - an einer nicht-initialen Position im Scanset einen Bereich angeben kann, wie in [0-9] .
  • Wenn eine Breitenangabe verwendet wird, wird nur bis zu width gematcht.
  • Speichert immer ein Nullzeichen zusätzlich zu den gematchten Zeichen (daher muss das Argument-Array Platz für mindestens width+1 Zeichen haben).
d

Passt auf eine dezimale Ganzzahl .

  • Das Zahlenformat entspricht dem von strtol mit dem Wert 10 für das base Argument.
signed char * oder unsigned char *
signed short * oder unsigned short *
signed int * oder unsigned int *
signed long * oder unsigned long *
signed long long * oder unsigned long long *
N/A
i

Erkennt eine Ganzzahl .

  • Das Zahlenformat entspricht dem von strtol mit dem Wert ​ 0 ​ für das base Argument (die Basis wird durch die ersten eingelesenen Zeichen bestimmt).
u

Entspricht einem vorzeichenlosen Dezimalzahl .

  • Das Zahlenformat ist identisch mit dem von strtoul erwarteten Format mit dem Wert 10 für das base Argument.
o

Entspricht einer vorzeichenlosen Oktalzahl .

  • Das Zahlenformat ist identisch mit dem von strtoul erwarteten Format mit dem Wert 8 für das base Argument.
x
X

Entspricht einem vorzeichenlosen hexadezimalen Integer .

  • Das Zahlenformat ist identisch mit dem von strtoul erwarteten Format mit dem Wert 16 für das base Argument.
n

Gibt die Anzahl der bisher gelesenen Zeichen zurück.

  • Es wird keine Eingabe konsumiert. Erhöht nicht die Zuweisungsanzahl.
  • Wenn der Format-Spezifizierer den Zuweisungsunterdrückungsoperator definiert hat, ist das Verhalten undefiniert.
a (C99)
A (C99)
e
E
f
F (C99)
g
G

Erkennt eine Gleitkommazahl .

  • Das Zahlenformat entspricht dem von strtof erwarteten Format.
N/A N/A
float *
double *
N/A N/A N/A N/A
long double *
p

Entspricht einer implementierungsdefinierten Zeichensequenz, die einen Zeiger definiert.

  • printf -Funktionen sollten dieselbe Sequenz mit dem %p -Formatbezeichner erzeugen.
N/A N/A
void **
N/A N/A N/A N/A N/A N/A
Hinweise

Für jeden Konvertierungsspezifizierer außer n wird die längste Sequenz von Eingabezeichen, die keine spezifizierte Feldbreite überschreitet und die entweder genau dem entspricht, was der Konvertierungsspezifizierer erwartet, oder ein Präfix einer Sequenz ist, die er erwarten würde, aus dem Strom konsumiert. Das erste Zeichen nach dieser konsumierten Sequenz, falls vorhanden, bleibt ungelesen. Wenn die konsumierte Sequenz eine Länge von null hat oder wenn die konsumierte Sequenz nicht wie oben spezifiziert konvertiert werden kann, tritt ein Übereinstimmungsfehler auf, es sei denn, das Dateiende, ein Kodierungsfehler oder ein Lesefehler verhinderte die Eingabe aus dem Strom, in welchem Fall es sich um einen Eingabefehler handelt.

Alle Konvertierungsspezifizierer außer [ , c und n konsumieren und verwerfen alle führenden Leerzeichen (bestimmt wie durch Aufruf von isspace ), bevor versucht wird, die Eingabe zu parsen. Diese konsumierten Zeichen zählen nicht zur spezifizierten maximalen Feldbreite.

Die Konvertierungsspezifizierer lc , ls und l [ führen eine Multibyte-zu-Breitzeichen-Konvertierung durch, als ob sie mbrtowc mit einem mbstate_t -Objekt aufrufen würden, das vor der Konvertierung des ersten Zeichens auf null initialisiert wurde.

Die Konvertierungsspezifizierer s und [ speichern immer den Nullterminator zusätzlich zu den übereinstimmenden Zeichen. Die Größe des Zielarrays muss mindestens um eins größer sein als die spezifizierte Feldbreite. Die Verwendung von % s oder % [ ohne Angabe der Zielarraygröße ist genauso unsicher wie gets .

Die korrekten Konvertierungsspezifikationen für die Festbreiten-Ganzzahltypen ( int8_t usw.) sind im Header <inttypes.h> definiert (obwohl SCNdMAX , SCNuMAX usw. synonym mit % jd , % ju usw. ist).

Es gibt einen Sequenzpunkt nach der Aktion jedes Konvertierungsspezifizierers; dies erlaubt das Speichern mehrerer Felder in derselben "Senken"-Variable.

Beim Parsen eines unvollständigen Gleitkommawerts, der im Exponenten ohne Ziffern endet, wie z.B. das Parsen von "100er" mit dem Konvertierungsspezifizierer % f , wird die Sequenz "100e" (das längste Präfix einer möglicherweise gültigen Gleitkommazahl) konsumiert, was zu einem Übereinstimmungsfehler führt (die konsumierte Sequenz kann nicht in eine Gleitkommazahl konvertiert werden), wobei "r" übrig bleibt. Einige bestehende Implementierungen folgen dieser Regel nicht und rollen zurück, um nur "100" zu konsumieren, und lassen "er" übrig, z.B. glibc bug 1765 .

Wenn eine Konvertierungsspezifikation ungültig ist, ist das Verhalten undefiniert.

Rückgabewert

1-3) Anzahl der erfolgreich zugewiesenen empfangenen Argumente, oder EOF wenn ein Lesefehler auftritt, bevor das erste empfangene Argument zugewiesen wurde.
4-6) Gleich wie (1-3) , außer dass EOF auch zurückgegeben wird, falls eine Runtime Constraint-Verletzung auftritt.

Hinweise

Alle diese Funktionen rufen va_arg mindestens einmal auf, der Wert von arg ist nach der Rückgabe nicht definiert. Diese Funktionen rufen nicht va_end auf, dies muss vom Aufrufer durchgeführt werden.

Beispiel

Diesen Code ausführen 
#include <stdio.h>
#include <stdbool.h>
#include <stdarg.h>
bool checked_sscanf(int count, const char* buf, const char *fmt, ...)
{
    va_list ap;
    va_start(ap, fmt);
    int rc = vsscanf(buf, fmt, ap);
    va_end(ap);
    return rc == count;
}
int main(void)
{
    int n, m;
    printf("Parsing '1 2'...");
    if(checked_sscanf(2, "1 2", "%d %d", &n, &m))
        puts("success");
    else
        puts("failure");
    printf("Parsing '1 a'...");
    if(checked_sscanf(2, "1 a", "%d %d", &n, &m))
        puts("success");
    else
        puts("failure");
}

Ausgabe: 

Parsing '1 2'...success
Parsing '1 a'...failure

Referenzen

  • C11-Standard (ISO/IEC 9899:2011):
  • 7.21.6.9 Die vfscanf-Funktion (S. 327)
  • 7.21.6.11 Die vscanf-Funktion (S. 328)
  • 7.21.6.14 Die vsscanf-Funktion (S. 330)
  • K.3.5.3.9 Die vfscanf_s-Funktion (S. 597-598)
  • K.3.5.3.11 Die vscanf_s-Funktion (S. 599)
  • K.3.5.3.14 Die vsscanf_s-Funktion (S. 602)
  • C99-Standard (ISO/IEC 9899:1999):
  • 7.19.6.9 Die vfscanf-Funktion (S. 293)
  • 7.19.6.11 Die vscanf-Funktion (S. 294)
  • 7.19.6.14 Die vsscanf-Funktion (S. 295)

Siehe auch

(C11) (C11) (C11)
liest formatierten Input von stdin , einem Dateistream oder einem Buffer
(Funktion)
(C99) (C11) (C11) (C11) (C11)
gibt formatierten Output an stdout , einen Dateistream oder einen Buffer aus
unter Verwendung einer variablen Argumentenliste
(Funktion)
C++-Dokumentation für vscanf , vfscanf , vsscanf