Namespaces
Variants

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

From cppreference.net
< cpp ‎ | io ‎ | c
C++
Input/output library
C-style I/O
Definiert im Header <cstdio>
int vscanf ( const char * format, std :: va_list vlist ) ;
(1) (seit C++11)
int vfscanf ( std:: FILE * stream, const char * format, std :: va_list vlist ) ;
(2) (seit C++11)
int vsscanf ( const char * buffer, const char * format, std :: va_list vlist ) ;
(3) (seit C++11)

Liest Daten aus verschiedenen Quellen, interpretiert sie gemäß format und speichert die Ergebnisse an 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 .

Inhaltsverzeichnis

Parameter

stream - Eingabedateistream zum Lesen
buffer - Zeiger auf einen nullterminierten Zeichenstring zum Lesen
format - Zeiger auf einen nullterminierten Zeichenstring, der die Eingabeart spezifiziert
vlist - Variable Argumentenliste mit den empfangenden Argumenten


Die Format -Zeichenkette besteht aus

  • Nicht-Leerzeichen-Multibyte-Zeichen außer % : Jedes solche Zeichen in der Formatzeichenfolge konsumiert genau ein identisches Zeichen aus dem Eingabestrom oder führt dazu, dass die Funktion fehlschlägt, wenn das nächste Zeichen im Strom nicht gleich ist.
  • Leerzeichenzeichen: Jedes einzelne Leerzeichenzeichen in der Formatzeichenfolge konsumiert alle verfügbaren aufeinanderfolgenden Leerzeichenzeichen aus der Eingabe (bestimmt wie durch wiederholtes Aufrufen von std::isspace ). Beachten Sie, dass es keinen Unterschied zwischen " \n " , " " , " \t \t " oder anderen Leerzeichen in der Formatzeichenfolge gibt.
  • Konvertierungsspezifikationen. Jede Konvertierungsspezifikation hat das folgende 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 tatsächlichen 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:

Konvertierungsspezifizierer
Erklärung Erwarteter
Argumenttyp
Längenmodifikator→ hh h keine l ll j z t L
Nur verfügbar seit C++11→ 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 .

  • Bei Verwendung eines Breiten-Spezifizierers werden exakt Breite Zeichen erfasst (das Argument muss ein Zeiger auf ein Array mit ausreichend Platz sein).
  • Im Gegensatz zu %s und %[ wird dem Array kein Nullzeichen 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 width 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 width+1 Zeichen haben).
[ set  ]

Entspricht einer nicht-leeren Zeichenfolge aus der set von Zeichen.

  • Wenn das erste Zeichen der Menge ^ ist, werden alle Zeichen außerhalb der Menge erfasst.
  • Wenn die Menge mit ] oder ^] beginnt, wird das ] -Zeichen ebenfalls in die Menge 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, werden nur bis zu width Zeichen erfasst.
  • Speichert immer ein Nullzeichen zusätzlich zu den erfassten Zeichen (daher muss das Argument-Array Platz für mindestens width+1 Zeichen bieten).
d

Passt auf eine dezimale Ganzzahl .

  • Das Zahlenformat entspricht dem von std::strtol mit dem Wert 10 für das base Argument erwarteten.
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 std::strtol erwarteten Format mit dem Wert ​ 0 ​ für das base Argument (die Basis wird durch die ersten geparsten Zeichen bestimmt).
u

Entspricht einem vorzeichenlosen Dezimalzahl .

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

Entspricht einer vorzeichenlosen Oktalzahl .

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

Erkennt eine vorzeichenlose hexadezimale Ganzzahl .

  • Das Zahlenformat entspricht dem von std::strtoul mit dem Wert 16 für das base Argument erwarteten Format.
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 (C++11)
A (C++11)
e
E
f
F (C++11)
g
G

Passt auf eine Gleitkommazahl .

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

Erfasst die implementierungsdefinierte Zeichensequenz, die einen Zeiger definiert.

  • printf -Funktionsfamilie sollte 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 Folge von Eingabezeichen, die keine spezifizierte Feldbreite überschreitet und die entweder genau dem entspricht, was der Konvertierungsspezifizierer erwartet, oder ein Präfix einer solchen Folge ist, aus dem Strom gelesen. Das erste Zeichen nach dieser gelesenen Folge bleibt ungelesen. Wenn die gelesene Folge die Länge null hat oder wenn die gelesene Folge 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 verbrauchen und verwerfen alle führenden Leerzeichen (bestimmt wie durch Aufruf von std::isspace ), bevor versucht wird, die Eingabe zu parsen. Diese verbrauchten Zeichen zählen nicht zur spezifizierten maximalen Feldbreite.

Die Konvertierungsspezifizierer lc , ls und l [ führen eine Multibyte-zu-Breitzeichen-Konvertierung durch, wie durch Aufruf von std::mbrtowc mit einem std::mbstate_t -Objekt, 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 std::gets .

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

Es gibt einen Sequenzpunkt nach der Aktion jedes Konvertierungsspezifizierers; dies ermöglicht 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) gelesen, was zu einem Übereinstimmungsfehler führt (die gelesene Sequenz kann nicht in eine Gleitkommazahl konvertiert werden), wobei "r" übrig bleibt. Einige bestehende Implementierungen befolgen diese Regel nicht und rollen zurück, um nur "100" zu lesen, wobei "er" übrig bleibt, z.B. glibc bug 1765 .

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

Rückgabewert

Anzahl der erfolgreich gelesenen Argumente, oder EOF bei Auftreten eines Fehlers.

Hinweise

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

Beispiel

Diesen Code ausführen 
#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 << "Parsing '1 2'... ";
        checked_sscanf(2, "1 2", "%d %d", &n, &m);
        std::cout << "success\n";
        std::cout << "Parsing '1 a'... ";
        checked_sscanf(2, "1 a", "%d %d", &n, &m);
        std::cout << "success\n";
    }
    catch (const std::exception& e)
    {
        std::cout << e.what() << '\n';
    }
}

Ausgabe: 

Parsing '1 2'... success
Parsing '1 a'... parsing error

Siehe auch

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