vsnprintf
, , _vsnprintf
_vsnprintf_l
, , _vsnwprintf
_vsnwprintf_l
Schreiben von formatierter Ausgabe mithilfe eines Zeigers, der auf eine Liste von Argumenten zeigt. Sicherere Versionen dieser Funktionen sind verfügbar; siehe , , _vsnprintf_s
, _vsnprintf_s_l
, _vsnwprintf_s
, _vsnwprintf_s_l
.vsnprintf_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
Parameter
buffer
Speicherort für die Ausgabe.
count
Maximale Anzahl der zu schreibenden Zeichen. Für die Funktionen, die verwendet wchar_t
werden, ist es die Anzahl der zu schreibenden breiten Zeichen.
format
Formatangabe.
argptr
Zeiger zur Liste der Argumente.
locale
Das zu verwendende Gebietsschema.
Weitere Informationen finden Sie unter Formatspezifikations-Syntax.
Rückgabewert
Die Anzahl der geschriebenen Zeichen, nicht einschließlich des Beendens NULL
oder eines negativen Werts, wenn ein Ausgabefehler auftritt.
Ausführliche Informationen finden Sie in der Verhaltenszusammenfassung .
Hinweise
Jede dieser Funktionen verwendet einen Zeiger auf eine Argumentliste, formatiert die Daten und schreibt bis zu count
Zeichen in den Speicher, auf den von buffer
gezeigt wird. Die vsnprintf
-Funktion schreibt immer einen NULL-Terminator, selbst wenn die Ausgabe abgeschnitten wird. Wenn Sie den Puffer verwenden _vsnprintf
und _vsnwprintf
, wird der Puffer nur dann null beendet, wenn am Ende Platz vorhanden ist (d. r., wenn die Anzahl der zu schreibenden Zeichen kleiner als count
ist).
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; _vsnprintf
wird zur Abwärtskompatibilität mit älterem Code beibehalten. Der Unterschied besteht darin, dass, wenn sie nicht mehr puffern, vsnprintf
das Ende des Puffers null beendet und die Anzahl der erforderlichen Zeichen zurückgibt, während _vsnprintf
der Puffer nicht null beendet und -1 zurückgegeben wird. Enthält außerdem ein weiteres Zeichen in der Ausgabe, _vsnprintf()
da er den Puffer nicht null beendet.
Wichtig
Um bestimmte Arten von Sicherheitsrisiken zu verhindern, stellen Sie sicher, dass format
es sich nicht um eine benutzerdefinierte Zeichenfolge handelt. Weitere Informationen finden Sie unter Vermeiden von Pufferüberläufen.
Ab Windows 10 Version 2004 (Build 19041) gibt die printf
-Funktionsfamilie exakt darstellbare Fließkommazahlen gemäß den IEEE 754-Rundungsregeln aus. In früheren Versionen von Windows wurden exakt darstellbare Fließkommazahlen, die auf „5“ endeten, immer aufgerundet. IEEE 754 besagt, dass sie auf die nächste gerade Ziffer gerundet werden müssen (auch bekannt als „Unverzerrte Rundung“). Beispielsweise sollten sowohl printf("%1.0f", 1.5)
als auch printf("%1.0f", 2.5)
auf 2 gerundet werden. Zuvor wurde 1,5 auf 2 und 2,5 auf 3 gerundet. Diese Änderung wirkt sich nur auf genau darstellbare Zahlen aus. 2,35 (was bei der Darstellung im Speicher näher an 2,35000000000000008 liegt) rundet zum Beispiel weiterhin auf 2,4 auf. Die Rundung durch diese Funktionen berücksichtigt nun auch den Fließkomma-Rundungsmodus, der durch fesetround
festgelegt wird. Zuvor wählte die Rundung immer das FE_TONEAREST
-Verhalten. Diese Änderung betrifft nur Programme, die mit Visual Studio 2019, Version 16.2 und höher erstellt wurden. Um das alte Fließkomma-Rundungsverhalten zu verwenden, verknüpfen Sie mit 'legacy_stdio_float_rounding.obj`.
Hinweis
Um sicherzustellen, dass beim Aufrufen des Aufrufs _vsnprintf
_vsnprintf_l
_vsnwprintf
von NULL Platz für das Beenden von NULL vorhanden ist, und _vsnwprintf_l
stellen Sie sicher, dass count
die Pufferlänge streng kleiner ist als die Pufferlänge und den Puffer vor dem Aufrufen der Funktion auf NULL initialisieren.
Da vsnprintf
immer ein Endwert null geschrieben wird, kann der count
Parameter der Größe des Puffers entsprechen.
Die Versionen dieser Funktionen mit dem _l
-Suffix sind beinahe identisch, verwenden jedoch den ihnen übergebenen Gebietsschemaparameter anstelle des aktuellen Threadgebietsschemas.
In C++ haben diese Funktionen Vorlagenüberladungen, mit denen die neueren, sicheren Entsprechungen dieser Funktionen aufgerufen werden. Weitere Informationen finden Sie unter Secure Template Overloads.
Verhaltenszusammenfassung
Für die folgende Tabelle:
- Lassen Sie uns
sizeOfBuffer
die Größe vonbuffer
. Wenn die Funktion einenchar
Puffer verwendet, befindet sich die Größe in Byte. Wenn die Funktion einenwchar_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 einenchar
Puffer verwendet, befindet sich die Größe in Byte. Wenn die Funktion einenwchar_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 einenchar
Puffer verwenden, und zeichenwchar_t
für Funktionen, die einenwchar_t
Puffer verwenden. - Weitere Informationen zum ungültigen Parameterhandler finden Sie unter Parameterüberprüfung.
Bedingung | Behavior | Rückgabewert | errno |
Ruft ungültige Parametertyphandler auf |
---|---|---|---|---|
Erfolgreich | Schreibt die Zeichen mithilfe der angegebenen Formatzeichenfolge in den Puffer. | Die Anzahl der geschriebenen Zeichen, ohne das endende NULL-Zeichen zu zählen. | N/V | No |
Codierungsfehler während der Formatierung | Wenn die Verarbeitung des Zeichenfolgenbezeichners s oder S der Z Formatierungsspezifikation beendet wird. |
-1 | EILSEQ (42) |
No |
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) |
No |
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 |
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. |
N/V | No |
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. | N/V | No |
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 . |
N/V | No |
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. |
N/V | No |
count >= sizeOfBuffer und len < sizeOfBuffer |
Alle Daten werden mit einer Beendigung NULL geschrieben. |
Die Anzahl der geschriebenen Zeichen, nicht einschließlich des Beendens NULL . |
N/V | No |
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 . |
N/V | No |
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 , , errno
, _sys_errlist
und _sys_nerr
._doserrno
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 _vsnprintf
, _vsnprintf_l
_vsnwprintf
und _vsnwprintf_l
Funktionen sind Microsoft-spezifisch. Weitere Informationen zur Kompatibilität finden Sie unter Kompatibilität.
Beispiel: Verwenden von breiten Zeichen 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 Parametern mit schmaler Zeichenfolge verwenden. Der count
-Parameter kann die gesamte Größe des Puffers sein, und der Rückgabewert ist die Anzahl der Zeichen, die geschrieben wären worden, wenn count
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
Formatspezifikationssyntax: printf
und wprintf
Funktionen
fprintf
, , _fprintf_l
fwprintf
_fwprintf_l
printf
, , _printf_l
wprintf
_wprintf_l
sprintf
, , _sprintf_l
swprintf
, , _swprintf_l
__swprintf_l
va_arg
, , va_copy
va_end
va_start
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Tickets als Feedbackmechanismus für Inhalte auslaufen lassen und es durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter:Einreichen und Feedback anzeigen für