`vsnprintf`, , `_vsnprintf_vsnprintf_l`, , `_vsnwprintf_vsnwprintf_l`

2025-06-21

Schreiben Sie formatierte Ausgaben mit einem Zeiger auf eine Liste von Argumenten. Es stehen sicherere Versionen dieser Funktionen zur Verfügung. siehe vsnprintf_s, _vsnprintf_s, , _vsnprintf_s_l, _vsnwprintf_s_l_vsnwprintf_s.

Syntax

int vsnprintf(
   char *buffer,
   size_t count,
   const char *format,
   va_list argptr
);

int _vsnprintf(
   char *buffer,
   size_t count,
   const char *format,
   va_list argptr
);

int _vsnprintf_l(
   char *buffer,
   size_t count,
   const char *format,
   _locale_t locale,
   va_list argptr
);

int _vsnwprintf(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   va_list argptr
);

int _vsnwprintf_l(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   _locale_t locale,
   va_list argptr
);

template <size_t size>
int vsnprintf(
   char (&buffer)[size],
   size_t count,
   const char *format,
   va_list argptr
); // C++ only

template <size_t size>
int _vsnprintf(
   char (&buffer)[size],
   size_t count,
   const char *format,
   va_list argptr
); // C++ only

template <size_t size>
int _vsnprintf_l(
   char (&buffer)[size],
   size_t count,
   const char *format,
   _locale_t locale,
   va_list argptr
); // C++ only

template <size_t size>
int _vsnwprintf(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format,
   va_list argptr
); // C++ only

template <size_t size>
int _vsnwprintf_l(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format,
   _locale_t locale,
   va_list argptr
); // C++ only

Die Parameter

buffer
Speicherort für die Ausgabe.

count
Maximale Anzahl der zu schreibenden Zeichen. Für die Funktionen, die verwenden wchar_t, ist es die Anzahl der zu schreibenden Breitzeichen.

format
Format-Spezifikation.

argptr
Zeiger auf eine Liste von Argumenten.

locale
Das zu verwendende Gebietsschema.

Weitere Informationen finden Sie unter Syntax der Formatspezifikation.

Rückgabewert

Die Anzahl der geschriebenen Zeichen, ohne den abschließenden NULLoder negativen Wert, wenn ein Ausgabefehler auftritt.

Ausführliche Informationen finden Sie in der Verhaltenszusammenfassung .

Bemerkungen

Jede dieser Funktionen verwendet einen Zeiger auf eine Argumentliste, formatiert dann die Daten und schreibt bis zu count Zeichen in den Speicher, auf den mit bufferzeigt. Die vsnprintf Funktion schreibt immer ein Null-Abschlusszeichen, auch wenn die Ausgabe abgeschnitten wird. Wenn Sie und _vsnwprintfverwenden_vsnprintf, wird der Puffer nur dann nullterminiert, wenn am Ende Platz ist (d. h., wenn die Anzahl der zu schreibenden Zeichen kleiner als countist).

Beginnend mit der UCRT in Visual Studio 2015 und Windows 10 ist vsnprintf nicht mehr identisch mit _vsnprintf. Die vsnprintf Funktion entspricht dem C99-Standard und _vsnprintf wird aus Gründen der Abwärtskompatibilität mit älterem Code beibehalten. Der Unterschied besteht darin, dass, wenn der Puffer ausgeht, vsnprintf das Ende des Puffers mit null beendet und die Anzahl der Zeichen zurückgegeben wird, die erforderlich gewesen wären, während _vsnprintf der Puffer nicht null beendet wird und -1 zurückgegeben wird. Enthält außerdem ein weiteres Zeichen in der Ausgabe, _vsnprintf() da er den Puffer nicht null beendet.

Von Bedeutung

Um bestimmte Arten von Sicherheitsrisiken zu vermeiden, stellen Sie sicher, dass es format sich nicht um eine benutzerdefinierte Zeichenfolge handelt. Weitere Informationen finden Sie unter Vermeiden von Pufferüberläufen. Ab Windows 10 Version 2004 (Build 19041) druckt die printf Funktionsfamilie exakt darstellbare Gleitkommazahlen gemäß den IEEE 754-Regeln für die Rundung. In früheren Versionen von Windows wurden genau darstellbare Gleitkommazahlen, die auf "5" endeten, immer aufgerundet. IEEE 754 besagt, dass sie auf die nächste gerade Ziffer runden müssen (auch bekannt als "Banker's Rounding"). Zum Beispiel sollte sowohl als auch printf("%1.0f", 1.5)printf("%1.0f", 2.5) auf 2 gerundet werden. Zuvor wurde 1,5 auf 2 und 2,5 auf 3 gerundet. Diese Änderung betrifft nur exakt darstellbare Zahlen. Beispiel: 2,35 (das, wenn es im Speicher dargestellt wird, näher an 2,350000000000000008 liegt) rundet weiter auf 2,4 auf. Die Rundung, die von diesen Funktionen durchgeführt wird, berücksichtigt nun auch den von festgelegten Gleitkomma-Rundungsmodus fesetround. Zuvor wählte die Rundung immer das Verhalten aus FE_TONEAREST . Diese Änderung betrifft nur Programme, die mit Visual Studio 2019 Version 16.2 und höher erstellt wurden. Um das alte Gleitkomma-Rundungsverhalten zu verwenden, verknüpfen Sie mit 'legacy_stdio_float_rounding.obj'.

Hinweis

Um sicherzustellen, dass beim Aufrufen _vsnprintfvon , und _vsnwprintf_lPlatz für den abschließenden null-Wert vorhanden ist, stellen Sie sicher, _vsnprintf_l_vsnwprintf dass dieser count Wert streng kleiner als die Pufferlänge ist, und initialisieren Sie den Puffer vor dem Aufrufen der Funktion auf null.

Da vsnprintf immer eine abschließende NULL-Datei geschrieben wird, kann der count Parameter der Größe des Puffers entsprechen.

Die Versionen dieser Funktionen mit dem _l Suffix sind identisch, mit der Ausnahme, dass sie den übergebenen locale-Parameter anstelle des aktuellen Thread-Gebietsschemas verwenden.

In C++ verfügen diese Funktionen über Vorlagenüberladungen, die die neueren, sicheren Entsprechungen dieser Funktionen aufrufen. Weitere Informationen finden Sie unter Secure Template Overloads.

Verhaltenszusammenfassung

Für die folgende Tabelle:

Lassen Sie uns sizeOfBuffer die Größe von buffer. Wenn die Funktion einen char Puffer verwendet, befindet sich die Größe in Byte. Wenn die Funktion einen wchar_t Puffer verwendet, gibt die Größe die Anzahl der 16-Bit-Wörter an.
Lassen Sie uns len die Größe der formatierten Daten sein. Wenn die Funktion einen char Puffer verwendet, befindet sich die Größe in Byte. Wenn die Funktion einen wchar_t Puffer verwendet, gibt die Größe die Anzahl der 16-Bit-Wörter an.
Zeichen beziehen sich auf char Zeichen für Funktionen, die einen char Puffer verwenden, und zeichen wchar_t für Funktionen, die einen wchar_t Puffer verwenden.
Weitere Informationen zum ungültigen Parameterhandler finden Sie unter Parameterüberprüfung.

Zustand	Verhalten	Rückgabewert	`errno`	Ruft ungültige Parametertyphandler auf
Erfolg	Schreibt die Zeichen mithilfe der angegebenen Formatzeichenfolge in den Puffer.	Die Anzahl der geschriebenen Zeichen, ohne das abschließende Nullzeichen.	Nicht verfügbar	Nein
Codierungsfehler während der Formatierung	Wenn die Verarbeitung des Zeichenfolgenbezeichners `s`, `S`oder `Z`, wird die Verarbeitung der Formatspezifikation gestoppt.	–1	`EILSEQ` (42)	Nein
Codierungsfehler während der Formatierung	Bei der Verarbeitung des Zeichenbezeichners `c` oder `C`wird das ungültige Zeichen übersprungen. Die Anzahl der geschriebenen Zeichen wird für das übersprungene Zeichen nicht erhöht, oder es werden keine Daten dafür geschrieben. Die Verarbeitung der Formatspezifikation wird fortgesetzt, nachdem der Bezeichner mit dem Codierungsfehler übersprungen wurde.	Die Anzahl der geschriebenen Zeichen, nicht einschließlich des Beendens `NULL`.	`EILSEQ` (42)	Nein
`buffer == NULL` und `count != 0`	Wenn die Ausführung nach ausführung eines ungültigen Parameterhandlers fortgesetzt wird, wird ein negativer Wert festgelegt `errno` und zurückgegeben.	–1	`EINVAL` (22)	Ja
`buffer == NULL` und `count == 0`	Es werden keine Daten geschrieben	Die Anzahl der Zeichen, die geschrieben wurden, nicht einschließlich des Beendens `NULL`. Sie können dieses Ergebnis verwenden, um genügend Pufferraum für die Zeichenfolge und eine Beendigung `NULL`zuzuweisen, und dann die Funktion erneut aufrufen, um den Puffer auszufüllen.	Nicht verfügbar	Nein
`count == 0`	Es werden keine Daten geschrieben	–1	`ERANGE` (34)	Nein
`count < 0`	Unsicher: Der Wert wird als nicht signiert behandelt, wahrscheinlich wird ein großer Wert erstellt, der dazu führt, dass der Speicher, der dem Puffer folgt, überschrieben wird.	Die Anzahl der geschriebenen Zeichen.	Nicht verfügbar	Nein
`count < sizeOfBuffer` und `len <= count`	Alle Daten werden geschrieben, und eine Beendigung `NULL` wird angefügt.	Die Anzahl der geschriebenen Zeichen, nicht einschließlich des Beendens `NULL`.	Nicht verfügbar	Nein
`count < sizeOfBuffer` und `len > count`	Die ersten `count-1` Zeichen werden gefolgt von einem Null-Terminator geschrieben.	Die Anzahl der Zeichen, die geschrieben wurden, stimmte `count` mit der Anzahl der auszuzugebenden Zeichen überein, nicht einschließlich des Null-Terminators.	Nicht verfügbar	Nein
`count >= sizeOfBuffer` und `len < sizeOfBuffer`	Alle Daten werden mit einer Beendigung `NULL`geschrieben.	Die Anzahl der geschriebenen Zeichen, nicht einschließlich des Beendens `NULL`.	Nicht verfügbar	Nein
`count >= sizeOfBuffer` und `len >= sizeOfBuffer`	Unsicher: Überschreibt den Speicher, der auf den Puffer folgt.	Die Anzahl der geschriebenen Zeichen, nicht einschließlich des Beendens `NULL`.	Nicht verfügbar	Nein
`format == NULL`	Es werden keine Daten geschrieben. Wenn die Ausführung nach ausführung eines ungültigen Parameterhandlers fortgesetzt wird, wird ein negativer Wert festgelegt `errno` und zurückgegeben.	–1	`EINVAL` (22)	Ja

Informationen zu diesen und anderen Fehlercodes finden Sie unter _doserrno.errno

Mapping generischer Textroutinen

`TCHAR.H`-Routine	`_UNICODE` und `_MBCS` nicht definiert	`_MBCS` definiert	`_UNICODE` definiert
`_vsntprintf`	`_vsnprintf`	`_vsnprintf`	`_vsnwprintf`
`_vsntprintf_l`	`_vsnprintf_l`	`_vsnprintf_l`	`_vsnwprintf_l`

Anforderungen

Routine	Erforderlicher Header (C)	Erforderlicher Header (C++)
`vsnprintf`, `_vsnprintf``_vsnprintf_l`	`<stdio.h>`	`<stdio.h>` oder `<cstdio>`
`_vsnwprintf`, `_vsnwprintf_l`	`<stdio.h>` oder `<wchar.h>`	`<stdio.h>`, `<wchar.h>`, `<cstdio>` oder `<cwchar>`

Die _vsnprintfFunktionen , _vsnprintf_lund _vsnwprintf_l_vsnwprintf sind Microsoft-spezifisch. Weitere Informationen zur Kompatibilität finden Sie unter Kompatibilität.

Beispiel: Verwenden Sie Breitzeichen mit `_vsnwprintf()`

// crt_vsnwprintf.c
// compile by using: cl /W3 crt_vsnwprintf.c

// To turn off error C4996, define this symbol:
#define _CRT_SECURE_NO_WARNINGS

#include <stdio.h>
#include <wtypes.h>

#define BUFFCOUNT (10)

void FormatOutput(LPCWSTR formatstring, ...)
{
    int nSize = 0;
    wchar_t buff[BUFFCOUNT];
    memset(buff, 0, sizeof(buff));
    va_list args;
    va_start(args, formatstring);
    // Note: _vsnwprintf is deprecated; consider vsnwprintf_s instead
    nSize = _vsnwprintf(buff, BUFFCOUNT - 1, formatstring, args); // C4996
    wprintf(L"nSize: %d, buff: %ls\n", nSize, buff);
    va_end(args);
}

int main() {
    FormatOutput(L"%ls %ls", L"Hi", L"there");
    FormatOutput(L"%ls %ls", L"Hi", L"there!");
    FormatOutput(L"%ls %ls", L"Hi", L"there!!");
}

nSize: 8, buff: Hi there
nSize: 9, buff: Hi there!
nSize: -1, buff: Hi there!

Das Verhalten ändert sich, wenn Sie stattdessen vsnprintf zusammen mit Narrow-String-Parametern verwenden. Der count Parameter kann die gesamte Größe des Puffers sein, und der Rückgabewert ist die Anzahl der Zeichen, die geschrieben worden wären, wenn count sie groß genug wäre:

Beispiel: Verwendung `vsnprintf()` mit schmalen Zeichenfolgen

// crt_vsnprintf.c
// compile by using: cl /W4 crt_vsnprintf.c
#include <stdio.h>
#include <stdarg.h> // for va_list, va_start
#include <string.h> // for memset

#define BUFFCOUNT (10)

void FormatOutput(char* formatstring, ...)
{
    int nSize = 0;
    char buff[BUFFCOUNT];
    memset(buff, 0, sizeof(buff));
    va_list args;
    va_start(args, formatstring);
    nSize = vsnprintf(buff, sizeof(buff), formatstring, args);
    printf("nSize: %d, buff: %s\n", nSize, buff);
    va_end(args);
}

int main() {
    FormatOutput("%s %s", "Hi", "there");   //  8 chars + null
    FormatOutput("%s %s", "Hi", "there!");  //  9 chars + null
    FormatOutput("%s %s", "Hi", "there!!"); // 10 chars + null
}

nSize: 8, buff: Hi there
nSize: 9, buff: Hi there!
nSize: 10, buff: Hi there!

Siehe auch

Stream-E/A
vprintf -Funktionen
Syntax der Formatspezifikation: printf und wprintf Funktionen
fprintf, , _fprintf_lfwprintf_fwprintf_l
printf, , _printf_lwprintf_wprintf_l
sprintf, _sprintf_l, swprintf, _swprintf_l, __swprintf_l
va_arg, , va_copyva_endva_start

Teilen über

vsnprintf, , _vsnprintf_vsnprintf_l, , _vsnwprintf_vsnwprintf_l