Namensräume
Varianten
Aktionen

vprintf, vfprintf, vsprintf, vsnprintf, vprintf_s, vfprintf_s, vsprintf_s, vsnprintf_s

Von cppreference.com
< c‎ | io
 
 
Datei-Ein-/Ausgabe
Typen und Objekte
        
Funktionen
Datei-Zugriff
(C95)
Unformatierte Ein-/Ausgabe
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)

Formatierte Eingabe
Direkte Ein-/Ausgabe
Formatierte Ausgabe
vprintfvfprintfvsprintfvsnprintfvprintf_svfprintf_svsprintf_svsnprintf_s
(C99)(C11)(C11)(C11)(C11)
Dateipositionierung
Fehlerbehandlung
Operationen auf Dateien
 
Definiert in Header <stdio.h>
(1)
int vprintf( const char* format, va_list vlist );
(bis C99)
int vprintf( const char* restrict format, va_list vlist );
(seit C99)
(2)
int vfprintf( FILE* stream, const char* format, va_list vlist );
(bis C99)
int vfprintf( FILE* restrict stream, const char* restrict format,
              va_list vlist );
(seit C99)
(3)
int vsprintf( char* buffer, const char* format, va_list vlist );
(bis C99)
int vsprintf( char* restrict buffer, const char* restrict format,
              va_list vlist );
(seit C99)
int vsnprintf( char* restrict buffer, size_t bufsz,
               const char* restrict format, va_list vlist );
(4) (seit C99)
int vprintf_s( const char* restrict format, va_list vlist );
(5) (seit C11)
int vfprintf_s( FILE* restrict stream, const char* restrict format,
                va_list vlist );
(6) (seit C11)
int vsprintf_s( char* restrict buffer, rsize_t bufsz,
                const char* restrict format, va_list vlist );
(7) (seit C11)
int vsnprintf_s( char* restrict buffer, rsize_t bufsz,
                 const char* restrict format, va_list vlist );
(8) (seit C11)

Lädt die Daten von den durch vlist definierten Speicherorten, wandelt sie in Zeichenkettenäquivalente um und schreibt die Ergebnisse in verschiedene Senken.

1) Schreibt die Ergebnisse nach stdout.
2) Schreibt die Ergebnisse in den Dateistream stream.
3) Schreibt die Ergebnisse in eine Zeichenkette buffer.
4) Schreibt die Ergebnisse in eine Zeichenkette buffer. Maximal bufsz - 1 Zeichen werden geschrieben. Die resultierende Zeichenkette wird mit einem Nullzeichen beendet, es sei denn, bufsz ist Null. Wenn bufsz Null ist, wird nichts geschrieben und buffer kann ein Nullzeiger sein, jedoch wird der Rückgabewert (Anzahl der Bytes, die geschrieben würden, ohne den Nullterminator) immer noch berechnet und zurückgegeben.
5-8) Ähnlich wie (1-4), außer dass die folgenden Fehler zur Laufzeit erkannt werden und die aktuell installierte Constraint-Handler-Funktion aufrufen.
  • der Konvertierungsspezifizierer %n im format vorhanden ist
  • eines der Argumente, die %s entsprechen, ein Nullzeiger ist
  • format oder buffer ein Nullzeiger ist
  • bufsz ist Null oder größer als RSIZE_MAX
  • bei der Konvertierung von Zeichenketten und Zeichenspezifizierern Kodierungsfehler auftreten
  • (nur für vsprintf_s) die in buffer zu speichernde Zeichenkette (einschließlich des abschließenden Nullzeichens) würde bufsz überschreiten.
Wie bei allen grenzgeprüften Funktionen sind vprintf_s, vfprintf_s, vsprintf_s und vsnprintf_s nur dann garantiert verfügbar, wenn __STDC_LIB_EXT1__ von der Implementierung definiert wird und wenn der Benutzer __STDC_WANT_LIB_EXT1__ vor dem Einbinden von <stdio.h> auf die Ganzzahlkonstante 1 setzt.

Inhalt

[edit] Parameter

stream - Ausgabestream, in den geschrieben werden soll
buffer - Zeiger auf eine Zeichenkette, in die geschrieben werden soll
bufsz - bis zu bufsz - 1 Zeichen können geschrieben werden, plus der Nullterminator
format - Zeiger auf eine nullterminierte Zeichenkette, die angibt, wie die Daten zu interpretieren sind
vlist - variablenargumentenliste, die die zu druckenden Daten enthält.

Die format-Zeichenkette besteht aus gewöhnlichen Byte-Zeichen (außer %), die unverändert in den Ausgabestrom kopiert werden, und Konversionsspezifikationen. Jede Konversionsspezifikation hat das folgende Format:

  • ein einführendes %-Zeichen.
  • (optional) ein oder mehrere Flags, die das Verhalten der Konversion modifizieren
  • -: Das Ergebnis der Konversion wird im Feld linksbündig ausgerichtet (standardmäßig rechtsbündig).
  • +: Das Vorzeichen von Vorzeichenkonversionen wird immer dem Ergebnis der Konversion vorangestellt (standardmäßig wird dem Ergebnis nur dann ein Minus vorangestellt, wenn es negativ ist).
  • Leerzeichen: Wenn das Ergebnis einer Vorzeichenkonversion nicht mit einem Vorzeichen beginnt oder leer ist, wird dem Ergebnis ein Leerzeichen vorangestellt. Es wird ignoriert, wenn das Flag + vorhanden ist.
  • #: Eine alternative Form der Konversion wird durchgeführt. Die genauen Effekte sind in der untenstehenden Tabelle aufgeführt, andernfalls ist das Verhalten undefiniert.
  • 0: Bei Ganzzahl- und Gleitkommazahlenkonversionen werden die Felder mit Nullen aufgefüllt anstelle von Leerzeichen. Bei Ganzzahlen wird dies ignoriert, wenn die Genauigkeit explizit angegeben ist. Bei anderen Konversionen führt die Verwendung dieses Flags zu undefiniertem Verhalten. Es wird ignoriert, wenn das Flag - vorhanden ist.
  • (optional) Ganzzahlwert oder *, der die minimale Feldbreite angibt. Das Ergebnis wird mit Leerzeichen (standardmäßig) aufgefüllt, falls erforderlich, links bei rechtsbündiger Ausrichtung oder rechts bei linksbündiger Ausrichtung. Wenn * verwendet wird, wird die Breite durch ein zusätzliches Argument vom Typ int angegeben, das vor dem zu konvertierenden Argument und dem Argument für die Präzision (falls vorhanden) steht. Wenn der Wert des Arguments negativ ist, führt dies zur Angabe des - Flags und einer positiven Feldbreite (Hinweis: Dies ist die minimale Breite: Der Wert wird nie gekürzt).
  • (optional) . gefolgt von einer Ganzzahl oder *, oder weder noch, das die Präzision der Konvertierung angibt. Wenn * verwendet wird, wird die Präzision durch ein zusätzliches Argument vom Typ int angegeben, das vor dem zu konvertierenden Argument steht, aber nach dem Argument für die minimale Feldbreite (falls vorhanden). Wenn der Wert dieses Arguments negativ ist, wird es ignoriert. Wenn weder eine Zahl noch * verwendet wird, wird die Präzision als Null angenommen. Die genauen Auswirkungen der Präzision finden Sie in der folgenden Tabelle.
  • (optional) Ein Längenmodifikator, der die Größe des Arguments angibt (in Kombination mit dem Konversionsformat-Spezifizierer gibt er den Typ des entsprechenden Arguments an).
  • Ein Konversionsformat-Spezifizierer.

Die folgenden Format-Spezifizierer sind verfügbar:

Konversion
Spezifizierer
Erklärung Erwartet
Argumenttyp
Längenmodifikator → hh h keine l ll j z t L
Nur verfügbar seit C99 → Ja Ja Ja Ja Ja
% Schreibt ein literales %. Die vollständige Konversionsspezifikation muss %% sein. N/A N/A N/A N/A N/A N/A N/A N/A N/A
c

Schreibt ein einzelnes Zeichen.

  • Das Argument wird zuerst in unsigned char konvertiert.
  • Wenn der Modifikator l verwendet wird, wird das Argument zuerst in eine Zeichenkette konvertiert, als ob durch %ls mit einem wchar_t[2]-Argument.
N/A N/A
int
wint_t
N/A N/A N/A N/A N/A
s

Schreibt eine Zeichenkette.

  • Das Argument muss ein Zeiger auf das erste Element eines Arrays von Zeichen sein.
  • Genauigkeit gibt die maximal zu schreibende Byte-Anzahl an. Wenn Genauigkeit nicht angegeben ist, werden alle Bytes bis zum ersten Nullterminator (ausschließlich) geschrieben.
  • Wenn der Spezifikator l verwendet wird, muss das Argument ein Zeiger auf das erste Element eines Arrays von wchar_t sein, das als Zeichenarray konvertiert wird, als ob durch einen Aufruf von wcrtomb mit einem mit Null initialisierten Konvertierungszustand.
N/A N/A
char*
wchar_t*
N/A N/A N/A N/A N/A
d
i

Konvertiert eine vorzeichenbehaftete Ganzzahl in die Dezimaldarstellung [-]dddd.

  • Präzision gibt die minimale Anzahl von Ziffern an, die erscheinen sollen. Die Standardpräzision ist 1.
  • Wenn sowohl der konvertierte Wert als auch die Präzision 0 sind, erzeugt die Konvertierung keine Zeichen.
  • Für den z-Modifikator ist der erwartete Argumenttyp die vorzeichenbehaftete Version von size_t.
signed char
short
int
long
long long
N/A
o

Konvertiert eine vorzeichenlose Ganzzahl in die Oktaldarstellung oooo.

  • Präzision gibt die minimale Anzahl von Ziffern an, die erscheinen sollen. Die Standardpräzision ist 1.
  • Wenn sowohl der konvertierte Wert als auch die Präzision 0 sind, erzeugt die Konvertierung keine Zeichen.
  • In der alternativen Implementierung wird die Präzision bei Bedarf erhöht, um eine führende Null zu schreiben. In diesem Fall wird, wenn sowohl der konvertierte Wert als auch die Präzision 0 sind, eine einzelne 0 geschrieben.
unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
vorzeichenbehaftete Version von ptrdiff_t
N/A
x
X

Konvertiert eine vorzeichenlose Ganzzahl in die Hexadezimaldarstellung hhhh.

  • Für die x-Konversionsbuchstaben werden abcdef verwendet.
  • Für die X-Konversionsbuchstaben werden ABCDEF verwendet.
  • Präzision gibt die minimale Anzahl von Ziffern an, die erscheinen sollen. Die Standardpräzision ist 1.
  • Wenn sowohl der konvertierte Wert als auch die Präzision 0 sind, erzeugt die Konvertierung keine Zeichen.
  • In der alternativen Implementierung wird den Ergebnissen 0x oder 0X vorangestellt, wenn der konvertierte Wert ungleich Null ist.
N/A
u

Konvertiert eine vorzeichenlose Ganzzahl in die Dezimaldarstellung dddd.

  • Genauigkeit gibt die minimale Anzahl der anzuzeigenden Ziffern an.
  • Die Standardpräzision ist 1.
  • Wenn sowohl der konvertierte Wert als auch die Präzision 0 sind, erzeugt die Konvertierung keine Zeichen.
N/A
f
F (C99)

Konvertiert eine Gleitkommazahl in die Dezimalnotation im Stil [-]ddd.ddd.

  • Genauigkeit gibt die genaue Anzahl der Ziffern nach dem Dezimaltrennzeichen an.
  • Die Standardpräzision ist 6.
  • In der alternativen Implementierung wird das Dezimaltrennzeichen auch dann geschrieben, wenn keine Ziffern darauf folgen.
  • Informationen zur Konversion von Unendlichkeit und Nicht-Zahl im Hinblick auf den Stil finden Sie unter Anmerkungen.
N/A N/A
double
double (C99)
N/A N/A N/A N/A
long double
e
E

Konvertiert eine Gleitkommazahl in die Dezimal-Exponent-Notation.

  • Für den e-Konversionsstil wird [-]d.ddd e±dd verwendet.
  • Für den E-Konversionsstil wird [-]d.ddd E±dd verwendet.
  • Der Exponent enthält mindestens zwei Ziffern, mehr Ziffern werden nur bei Bedarf verwendet.
  • Wenn der Wert 0 ist, ist auch der Exponent 0.
  • Genauigkeit gibt die genaue Anzahl der Ziffern nach dem Dezimaltrennzeichen an.
  • Die Standardpräzision ist 6.
  • In der alternativen Implementierung wird das Dezimaltrennzeichen auch dann geschrieben, wenn keine Ziffern darauf folgen.
  • Informationen zur Konversion von Unendlichkeit und Nicht-Zahl im Hinblick auf den Stil finden Sie unter Anmerkungen.
N/A N/A N/A N/A N/A N/A
a
A

(C99)

Konvertiert eine Gleitkommazahl in die Hexadezimal-Exponent-Notation.

  • Für den a-Konversionsstil wird [-] 0xh.hhh p±d verwendet.
  • Für den A-Konversionsstil wird [-] 0Xh.hhh P±d verwendet.
  • Die erste Hexadezimalziffer ist nicht 0, wenn das Argument ein normalisierter Gleitkommawert ist.
  • Wenn der Wert 0 ist, ist auch der Exponent 0.
  • Genauigkeit gibt die exakte Anzahl der Ziffern nach dem Hexadezimaltrennzeichen an.
  • Die Standardgenauigkeit ist ausreichend für die exakte Darstellung des Wertes.
  • In der alternativen Implementierung wird das Dezimaltrennzeichen auch dann geschrieben, wenn keine Ziffern darauf folgen.
  • Informationen zur Konversion von Unendlichkeit und Nicht-Zahl im Hinblick auf den Stil finden Sie unter Anmerkungen.
N/A N/A N/A N/A N/A N/A
g
G

Konvertiert eine Gleitkommazahl je nach Wert und Genauigkeit in die Dezimal- oder Dezimal-Exponent-Notation.

  • Für den g-Konversionsstil wird die Konversion mit dem Stil e oder f durchgeführt.
  • Für den G-Konvertierungsstil wird die Konvertierung im Stil E oder f(bis C99)F(seit C99) durchgeführt.
  • Sei P gleich der Präzision, wenn sie ungleich Null ist, 6, wenn die Präzision nicht angegeben ist, oder 1, wenn die Präzision 0 ist. Dann, wenn eine Konvertierung mit dem Stil E einen Exponenten von X hätte
    • Wenn P > X ≥ −4, erfolgt die Konvertierung im Stil f oder F(seit C99) und mit der Präzision P − 1 − X.
    • Andernfalls erfolgt die Konversion im Stil e oder E mit einer Genauigkeit von P − 1.
  • Sofern keine alternative Darstellung angefordert wird, werden nachfolgende Nullen entfernt, und das Dezimaltrennzeichen wird entfernt, wenn kein Bruchteil übrig bleibt.
  • Informationen zur Konversion von Unendlichkeit und Nicht-Zahl im Hinblick auf den Stil finden Sie unter Anmerkungen.
N/A N/A N/A N/A N/A N/A
n

Gibt die bisher von diesem Funktionsaufruf geschriebene Anzahl der Zeichen zurück.

  • Das Ergebnis wird an den Wert geschrieben, auf den das Argument zeigt.
  • Die Spezifikation darf keine Flags, Feldbreiten oder Genauigkeiten enthalten.
  • Für den z-Modifikator ist der erwartete Argumenttyp S*, wobei S die vorzeichenbehaftete Version von size_t ist.
signed char*
short*
int*
long*
long long*
N/A
p

Schreibt eine implementierungsdefinierte Zeichensequenz, die einen Zeiger darstellt.

N/A N/A
void*
N/A N/A N/A N/A N/A N/A
Anmerkungen

Die Gleitkommakonversionsfunktionen konvertieren Unendlichkeit in inf oder infinity. Welche Variante verwendet wird, ist implementierungsabhängig.

Nicht-Zahlen werden in nan oder nan(char_sequence) konvertiert. Welche Variante verwendet wird, ist implementierungsabhängig.

Die Konversionen F, E, G, A geben stattdessen INF, INFINITY, NAN aus.

Der Konvertierungsspezifikator, der zum Drucken von char, unsigned char, signed char, short und unsigned short verwendet wird, erwartet die typgeförderten Typen der Standard-Argumentbeförderungen, aber vor dem Drucken seines Wertes wird er in char, unsigned char, signed char, short und unsigned short konvertiert. Es ist sicher, Werte dieser Typen zu übergeben, da die Beförderung stattfindet, wenn eine variadische Funktion aufgerufen wird.

Die korrekten Konvertierungsspezifikationen für die festen Zeichentypen (int8_t, etc.) sind im Header <inttypes.h> definiert (obwohl PRIdMAX, PRIuMAX, etc. synonym mit %jd, %ju, etc. sind).

Der Speicher schreibende Konvertierungsspezifizierer %n ist ein häufiges Ziel von Sicherheitslücken, bei denen Formatzeichenketten von Benutzereingaben abhängen und wird von der grenzgeprüften printf_s-Funktionsfamilie nicht unterstützt(seit C11).

Nach der Ausführung jedes Konvertierungsspezifizierers gibt es einen Sequenzpunkt; dies ermöglicht es, mehrere %n-Ergebnisse in derselben Variablen zu speichern oder, als Grenzfall, einen durch ein früheres %n modifizierten String innerhalb desselben Aufrufs auszugeben.

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

[edit] Rückgabewert

1-3) Die Anzahl der erfolgreich geschriebenen Zeichen oder ein negativer Wert, wenn ein Fehler aufgetreten ist.
4) Die Anzahl der erfolgreich geschriebenen Zeichen oder ein negativer Wert, wenn ein Fehler aufgetreten ist. Wenn die resultierende Zeichenkette aufgrund der buf_size-Grenze abgeschnitten wird, gibt die Funktion die Gesamtzahl der Zeichen zurück (ohne das abschließende Nullzeichen), die geschrieben worden wären, wenn die Grenze nicht auferlegt worden wäre.
5,6) Anzahl der an den Ausgabestrom übertragenen Zeichen oder ein negativer Wert bei einem Ausgabefehler, einem Laufzeit-Constraint-Verletzungsfehler oder einem Kodierungsfehler.
7) Anzahl der in buffer geschriebenen Zeichen, ohne das Nullzeichen (das immer geschrieben wird, solange buffer kein Nullzeiger ist und bufsz nicht Null und nicht größer als RSIZE_MAX ist), oder Null bei Laufzeit-Constraint-Verletzungen und ein negativer Wert bei Kodierungsfehlern.
8) Anzahl der Zeichen, ohne das abschließende Nullzeichen (das immer geschrieben wird, solange buffer kein Nullzeiger ist und bufsz nicht Null und nicht größer als RSIZE_MAX ist), die in buffer geschrieben worden wären, wenn bufsz ignoriert worden wäre, oder ein negativer Wert bei einer Laufzeit-Constraint-Verletzung oder einem Kodierungsfehler.

[edit] Hinweise

Alle diese Funktionen rufen mindestens einmal va_arg auf; der Wert von arg ist nach der Rückgabe undefiniert. Diese Funktionen rufen va_end nicht auf, und dies muss vom Aufrufer erfolgen.

vsnprintf_s schneidet das Ergebnis im Gegensatz zu vsprintf_s auf das im durch buffer zeigende Array passende Ergebnis zu.

Die Implementierung von vsnprintf_s in der Microsoft CRT entspricht nicht dem C-Standard. Die Microsoft-Version hat einen zusätzlichen Parameter size_t count an dritter Stelle, der die maximal zu schreibende Anzahl von Zeichen (ohne Nullterminator) enthält. Dieser Parameter unterscheidet sich möglicherweise von der Puffergröße, die über den Parameter size_t bufsz bereitgestellt wird.

[edit] Beispiel

#include <stdarg.h>
#include <stdio.h>
#include <time.h>
 
void debug_log(const char* fmt, ...)
{
    struct timespec ts;
    timespec_get(&ts, TIME_UTC);
    char time_buf[100];
    size_t rc = strftime(time_buf, sizeof time_buf, "%D %T", gmtime(&ts.tv_sec));
    snprintf(time_buf + rc, sizeof time_buf - rc, ".%06ld UTC", ts.tv_nsec / 1000);
 
    va_list args1;
    va_start(args1, fmt);
    va_list args2;
    va_copy(args2, args1);
    char buf[1+vsnprintf(NULL, 0, fmt, args1)];
    va_end(args1);
    vsnprintf(buf, sizeof buf, fmt, args2);
    va_end(args2);
 
    printf("%s [debug]: %s\n", time_buf, buf);
}
 
int main(void)
{
    debug_log("Logging, %d, %d, %d", 1, 2, 3);
}

Mögliche Ausgabe

02/20/15 21:58:09.072683 UTC [debug]: Logging, 1, 2, 3

[edit] Referenzen

  • C23-Standard (ISO/IEC 9899:2024)
  • 7.21.6.8 Die Funktion vfprintf (S. TBD)
  • 7.21.6.10 Die Funktion vprintf (S. TBD)
  • 7.21.6.12 Die Funktion vsnprintf (S. TBD)
  • 7.21.6.13 Die Funktion vsprintf (S. TBD)
  • K.3.5.3.8 Die Funktion vfprintf_s (S. TBD)
  • K.3.5.3.10 Die Funktion vprintf_s (S. TBD)
  • K.3.5.3.12 Die Funktion vsnprintf_s (S. TBD)
  • K.3.5.3.13 Die Funktion vsprintf_s (S. TBD)
  • C17-Standard (ISO/IEC 9899:2018)
  • 7.21.6.8 Die Funktion vfprintf (S. 238)
  • 7.21.6.10 Die Funktion vprintf (S. 239)
  • 7.21.6.12 Die Funktion vsnprintf (S. 239-240)
  • 7.21.6.13 Die Funktion vsprintf (S. 240)
  • K.3.5.3.8 Die Funktion vfprintf_s (S. 434)
  • K.3.5.3.10 Die Funktion vprintf_s (S. 435)
  • K.3.5.3.12 Die Funktion vsnprintf_s (S. 436-437)
  • K.3.5.3.13 Die Funktion vsprintf_s (S. 437)
  • C11-Standard (ISO/IEC 9899:2011)
  • 7.21.6.8 Die Funktion vfprintf (S. 326-327)
  • 7.21.6.10 Die Funktion vprintf (S. 328)
  • 7.21.6.12 Die Funktion vsnprintf (S. 329)
  • 7.21.6.13 Die Funktion vsprintf (S. 329)
  • K.3.5.3.8 Die Funktion vfprintf_s (S. 597)
  • K.3.5.3.10 Die Funktion vprintf_s (S. 598-599)
  • K.3.5.3.12 Die Funktion vsnprintf_s (S. 600)
  • K.3.5.3.13 Die Funktion vsprintf_s (S. 601)
  • C99-Standard (ISO/IEC 9899:1999)
  • 7.19.6.8 Die Funktion vfprintf (S. 292)
  • 7.19.6.10 Die Funktion vprintf (S. 293)
  • 7.19.6.12 Die Funktion vsnprintf (S. 294)
  • 7.19.6.13 Die Funktion vsprintf (S. 295)
  • C89/C90-Standard (ISO/IEC 9899:1990)
  • 4.9.6.7 Die Funktion vfprintf
  • 4.9.6.8 Die Funktion vprintf
  • 4.9.6.9 Die Funktion vsprintf

[edit] Siehe auch

gibt formatierte Weitzeichenausgaben nach stdout, an einen Dateistream
oder einem Puffer mit variabler Argumentenliste
(Funktion) [bearbeiten]
gibt formatierte Ausgaben nach stdout, an einen Dateistream oder in einen Puffer aus
(Funktion) [bearbeiten]
liest formatierte Eingaben aus stdin, einem Dateistream oder einem Puffer
mit variabler Argumentenliste
(Funktion) [bearbeiten]
C++-Dokumentation für vprintf, vfprintf, vsprintf, vsnprintf