Namensräume
Varianten
Aktionen

wprintf, fwprintf, swprintf, wprintf_s, fwprintf_s, swprintf_s, snwprintf_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
wprintffwprintfswprintfwprintf_sfwprintf_sswprintf_ssnwprintf_s
(C95)(C95)(C95)(C11)(C11)(C11)(C11)  
Dateipositionierung
Fehlerbehandlung
Operationen auf Dateien
 
Definiert in Header <wchar.h>
(1)
int wprintf( const wchar_t* format, ... );
(seit C95)
(bis C99)
int wprintf( const wchar_t* restrict format, ... );
(seit C99)
(2)
int fwprintf( FILE* stream, const wchar_t* format, ... );
(seit C95)
(bis C99)
int fwprintf( FILE* restrict stream,
              const wchar_t* restrict format, ... );
(seit C99)
(3)
int swprintf( wchar_t* buffer, size_t bufsz,
              const wchar_t* format, ... );
(seit C95)
(bis C99)
int swprintf( wchar_t* restrict buffer, size_t bufsz,
              const wchar_t* restrict format, ... );
(seit C99)
int wprintf_s( const wchar_t* restrict format, ... );
(4) (seit C11)
int fwprintf_s( FILE* restrict stream,
                const wchar_t* restrict format, ... );
(5) (seit C11)
int swprintf_s( wchar_t* restrict buffer, rsize_t bufsz,
                const wchar_t* restrict format, ... );
(6) (seit C11)
int snwprintf_s( wchar_t* restrict s, rsize_t n,
                 const wchar_t* restrict format, ... );
(7) (seit C11)

Lädt die Daten von den angegebenen Speicherorten, konvertiert sie in Wide-String-Äquivalente und schreibt die Ergebnisse in eine Vielzahl von Senken.

1) Schreibt die Ergebnisse nach stdout.
2) Schreibt die Ergebnisse in den Dateistream stream.
3) Wenn bufsz größer als Null ist, werden die Ergebnisse in einen Wide-String-buffer geschrieben. Maximal bufsz - 1 Wide-Characters werden geschrieben, gefolgt von einem Null-Wide-Character. Wenn bufsz Null ist, wird nichts geschrieben (und buffer kann ein Null-Zeiger sein).
4-6) Ähnlich wie (1-3), 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 / sizeof(wchar_t)
  • bei der Konvertierung von Zeichenketten und Zeichenspezifizierern Kodierungsfehler auftreten
  • (nur für swprintf_s) die Anzahl der zu schreibenden Wide-Characters, einschließlich der Null, überschreitet bufsz.
7) Ähnlich wie (6), außer dass das Ergebnis abgeschnitten wird, um in das von s gezeigte Array zu passen.
Wie bei allen grenzgeprüften Funktionen sind wprintf_s, fwprintf_s, swprintf_s und snwprintf_s nur dann garantiert verfügbar, wenn __STDC_LIB_EXT1__ von der Implementierung definiert ist und wenn der Benutzer __STDC_WANT_LIB_EXT1__ auf die ganzzahlige Konstante 1 setzt, bevor <stdio.h> eingebunden wird.

Inhalt

[edit] Parameter

stream - Ausgabestream, in den geschrieben werden soll
buffer - Zeiger auf eine Wide-Character-Zeichenkette, in die geschrieben werden soll
bufsz - Bis zu bufsz - 1 Wide-Characters dürfen geschrieben werden, zuzüglich des Nullterminators
format - Zeiger auf eine nullterminierte Wide-Zeichenkette, die angibt, wie die Daten zu interpretieren sind
... - Argumente, die die zu druckenden Daten angeben. Wenn ein Argument nach Standard-Argument-Promotions nicht den von der entsprechenden Konvertierungsspezifikation erwarteten Typ hat oder wenn weniger Argumente als von format gefordert vorhanden sind, ist das Verhalten undefiniert. Wenn mehr Argumente vorhanden sind als von format gefordert, werden die überschüssigen Argumente ausgewertet und ignoriert.


Die format-Zeichenkette besteht aus normalen Wide-Zeichen (außer %), die unverändert in den Ausgabestrom kopiert werden, und Konvertierungsspezifikationen. Jede Konvertierungsspezifikation 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 wchar_t konvertiert, als ob btowc aufgerufen worden wäre.
  • Wenn der l-Modifikator verwendet wird, wird das wint_t-Argument zuerst in wchar_t konvertiert.
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 Zeichenarrays sein, das eine Multibyte-Zeichensequenz in Anfangszustand enthält, die in ein Wide-Character-Array konvertiert wird, als ob mbrtowc mit nullinitialisiertem Konvertierungszustand aufgerufen worden wäre.
  • Präzision gibt die maximale Anzahl von zu schreibenden Wide-Zeichen an. Wenn Präzision nicht angegeben ist, werden alle Wide-Zeichen bis zum ersten Nullterminator, diesen aber nicht einschließend, geschrieben.
  • Wenn der l-Spezifizierer verwendet wird, muss das Argument ein Zeiger auf das erste Element eines Arrays von wchar_t sein.
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 Konvertierungsspezifizierer zum Drucken von char, unsigned char, signed char, short und unsigned short erwartet die durch Standard-Argument-Promotions geförderten Typen, 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 Promotion erfolgt, 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,2) Anzahl der geschriebenen Wide-Characters im Erfolgsfall oder ein negativer Wert, wenn ein Fehler aufgetreten ist.
3) Anzahl der geschriebenen Wide-Characters (ohne den abschließenden Null-Wide-Character) im Erfolgsfall oder ein negativer Wert, wenn ein Kodierungsfehler aufgetreten ist oder wenn die Anzahl der zu generierenden Zeichen gleich oder größer als bufsz war (auch wenn bufsz Null ist).
4,5) Anzahl der geschriebenen Wide-Characters im Erfolgsfall oder ein negativer Wert, wenn ein Fehler aufgetreten ist.
6) Anzahl der Wide-Characters (ohne den abschließenden Null-Terminator), die in den buffer geschrieben wurden. Gibt einen negativen Wert bei Kodierungsfehlern und Überlauf zurück. Gibt Null bei allen anderen Fehlern zurück.
7) Anzahl der Wide-Characters (ohne den abschließenden Null-Terminator), die in den buffer geschrieben worden wären, wenn bufsz ausreichend groß gewesen wäre, oder ein negativer Wert, wenn ein Fehler auftritt. (Bedeutet: Der Schreibvorgang war erfolgreich und vollständig nur, wenn die Rückgabe nicht-negativ und kleiner als bufsz ist)

[edit] Hinweise

Während schmale Zeichenketten snprintf bieten, was es ermöglicht, die erforderliche Puffergröße für die Ausgabe zu bestimmen, gibt es kein Äquivalent für Wide-Strings (bis snwprintf_s)(seit C11), und um die Puffergröße zu bestimmen, muss das Programm möglicherweise swprintf aufrufen, das Ergebnis überprüfen und einen größeren Puffer neu zuweisen, wobei es versucht, bis zum Erfolg fortzufahren.

snwprintf_s schneidet im Gegensatz zu swprintf_s das Ergebnis ab, um in das von buffer gezeigte Array zu passen, obwohl das Abschneiden von den meisten grenzgeprüften Funktionen als Fehler behandelt wird.

[edit] Beispiel

#include <locale.h>
#include <wchar.h>
 
int main(void)
{
    char narrow_str[] = "z\u00df\u6c34\U0001f34c";
                  // or "zß水🍌"
                  // or "\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9f\x8d\x8c";
    wchar_t warr[29]; // the expected string is 28 characters plus 1 null terminator
    setlocale(LC_ALL, "en_US.utf8");
    swprintf(warr, sizeof warr / sizeof* warr,
             L"Converted from UTF-8: '%s'", narrow_str);
    wprintf(L"%ls\n", warr);
}

Ausgabe

Converted from UTF-8: 'zß水🍌'

[edit] Referenzen

  • C23-Standard (ISO/IEC 9899:2024)
  • 7.29.2.1 Die Funktion fwprintf (p: TBD)
  • 7.29.2.3 Die Funktion swprintf (p: TBD)
  • 7.29.2.11 Die Funktion wprintf (p: TBD)
  • K.3.9.1.1 Die Funktion fwprintf_s (p: TBD)
  • K.3.9.1.4 Die Funktion swprintf_s (p: TBD)
  • K.3.9.1.13 Die Funktion wprintf_s (p: TBD)
  • C17-Standard (ISO/IEC 9899:2018)
  • 7.29.2.1 Die Funktion fwprintf (p: TBD)
  • 7.29.2.3 Die Funktion swprintf (p: TBD)
  • 7.29.2.11 Die Funktion wprintf (p: TBD)
  • K.3.9.1.1 Die Funktion fwprintf_s (p: TBD)
  • K.3.9.1.4 Die Funktion swprintf_s (p: TBD)
  • K.3.9.1.13 Die Funktion wprintf_s (p: TBD)
  • C11-Standard (ISO/IEC 9899:2011)
  • 7.29.2.1 Die Funktion fwprintf (p: 403-410)
  • 7.29.2.3 Die Funktion swprintf (p: 416)
  • 7.29.2.11 Die Funktion wprintf (p: 421)
  • K.3.9.1.1 Die Funktion fwprintf_s (p: 628)
  • K.3.9.1.4 Die Funktion swprintf_s (p: 630-631)
  • K.3.9.1.13 Die Funktion wprintf_s (p: 637-638)
  • C99-Standard (ISO/IEC 9899:1999)
  • 7.24.2.1 Die Funktion fwprintf (p: 349-356)
  • 7.24.2.3 Die Funktion swprintf (p: 362)
  • 7.24.2.11 Die Funktion wprintf (p: 366)

[edit] Siehe auch

gibt formatierte Ausgaben nach stdout, an einen Dateistream oder in einen Puffer aus
(Funktion) [bearbeiten]
gibt formatierte Weitzeichenausgaben nach stdout, an einen Dateistream
oder einem Puffer mit variabler Argumentenliste
(Funktion) [bearbeiten]
(C95)
schreibt einen Weitzeichenstring in einen Dateistream
(Funktion) [bearbeiten]
C++-Dokumentation für wprintf, fwprintf, swprintf