vsnprintf_s, _vsnprintf_s, _vsnprintf_s_l, _vsnwprintf_s, _vsnwprintf_s_l

Schreiben von formatierter Ausgabe mithilfe eines Zeigers, der auf eine Liste von Argumenten zeigt. Diese Funktionen sind Versionen von vsnprintf, _vsnprintf, _vsnprintf_l, _vsnwprintfmit _vsnwprintf_l Sicherheitsverbesserungen, wie in sicherheitsfeatures in der CRT beschrieben.

Syntax

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

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

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

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

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

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

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

Parameter

buffer
Speicherort für die Ausgabe.

sizeOfBuffer
Die Größe der buffer Ausgabe. Größe in Byte für die Funktionen, die verwendet charwerden, und Wörter für diejenigen, die verwendet wchar_twerden.

count
Maximale Anzahl von Zeichen, die nicht mit dem Beenden NULLgeschrieben werden sollen. Für die Funktionen, die verwendet wchar_twerden, ist es die Anzahl der zu schreibenden breiten Zeichen. Oder _TRUNCATE.

format
Formatangabe.

argptr
Zeiger zur Liste der Argumente.

locale
Das Gebietsschema, das beim Formatieren der Ausgabe verwendet werden soll.

Weitere Informationen finden Sie unter "Formatspezifikationen".

Rückgabewert

Die Anzahl der geschriebenen Zeichen, nicht einschließlich des Beendens NULLoder eines negativen Werts, wenn ein Ausgabefehler auftritt.

Ausführliche Informationen finden Sie in der Verhaltenszusammenfassung .

Hinweise

vsnprintf_s ist identisch mit _vsnprintf_s und ist für die Konformität mit dem ANSI-Standard enthalten. _vnsprintf wird aus Gründen der Abwärtskompatibilität beibehalten.

Jede dieser Funktionen verwendet einen Zeiger auf eine Argumentliste und formatiert und schreibt dann bis zu count Zeichen der angegebenen Daten in den Arbeitsspeicher, auf den buffer verweist, und fügt ein abschließendes Nullzeichen an.

Die Versionen dieser Funktionen mit dem _l-Suffix sind beinahe identisch, verwenden jedoch den ihnen übergebenen Gebietsschemaparameter anstelle des aktuellen Threadgebietsschemas.

Verhaltenszusammenfassung

Für die folgende Tabelle:

• 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.

Bedingung	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	Nicht zutreffend	Nein
Codierungsfehler während der Formatierung	Wenn die Verarbeitung des Zeichenfolgenbezeichners soder Sder ZFormatierungsspezifikation beendet wird.	-1	EILSEQ (42)	Nein
Codierungsfehler während der Formatierung	Bei der Verarbeitung des Zeichenbezeichners c oder Cwird 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 == NULLund sizeOfBuffer == 0count == 0	Es werden keine Daten geschrieben.	0	Nicht zutreffend	Nein
buffer == NULL und entweder sizeOfBuffer != 0 oder 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 sizeOfBuffer == 0	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
count == 0	Schreibt keine Daten und gibt die Anzahl der Zeichen zurück, die geschrieben wurden, nicht einschließlich der Beendigung NULL.	Die Anzahl der Zeichen, die geschrieben wurden, nicht einschließlich des Beendens NULL.	Nicht zutreffend	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 einschließlich des Beendens NULL.	Nicht zutreffend	Nein
count < sizeOfBuffer und len <= count	Alle Daten werden geschrieben, und eine Beendigung NULL wird angefügt.	Die Anzahl der geschriebenen Zeichen.	Nicht zutreffend	Nein
count < sizeOfBuffer und len > count	Die ersten count Zeichen werden geschrieben.	-1	Nicht zutreffend	Nein
count >= sizeOfBuffer und len < sizeOfBuffer	Alle Daten werden mit einer Beendigung NULLgeschrieben.	Die Anzahl der geschriebenen Zeichen, nicht einschließlich des Beendens NULL.	Nicht zutreffend	Nein
count >= sizeOfBufferund len >= sizeOfBuffercount != _TRUNCATE	Wenn die Ausführung fortgesetzt wird, nachdem ein ungültiger Parameterhandler ausgeführt wird, wird festgelegt errno, festgelegt buffer[0] == NULLund ein negativer Wert zurückgegeben.	-1	ERANGE (34)	Ja
count == _TRUNCATE und len >= sizeOfBuffer	Schreibt so viel der Zeichenfolge, wie es passt buffer, einschließlich des Beendens NULL.	-1	Nicht zutreffend	Nein
count == _TRUNCATE und len < sizeOfBuffer	Schreibt die gesamte Zeichenfolge buffer mit dem Beenden NULLin .	Anzahl geschriebener Zeichen.	Nicht zutreffend	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 , , errno, _sys_errlistund _sys_nerr._doserrno

Wichtig

Stellen Sie sicher, dass format keine benutzerdefinierte Zeichenfolge ist. Weitere Informationen finden Sie unter Vermeiden von Pufferüberläufen. Ab Windows 10, Version 2004 (Build 19041), druckt die printf Funktionsfamilie exakt repräsentierbare Gleitkommazahlen gemäß den IEEE 754-Regeln zum Runden. In früheren Versionen von Windows würden exakt dargestellte Gleitkommazahlen, die auf "5" enden, immer aufgerundet. IEEE 754 gibt an, dass sie auf die nächstgelegene gerade Ziffer runden müssen (auch bekannt als "Banker es Rounding"). Beispielsweise sollten beide printf("%1.0f", 1.5) auf printf("%1.0f", 2.5) 2 gerundet werden. Zuvor würde 1,5 auf 2 und 2,5 runden auf 3. Diese Änderung wirkt sich nur auf genau darstellbare Zahlen aus. Beispielsweise wird 2.35 (die, wenn sie im Arbeitsspeicher dargestellt wird, näher an 2.35000000000000008) weiter auf 2,4 aufgerundet. Das Runden dieser Funktionen berücksichtigt nun auch den gleitkommafreien Rundungsmodus, der von fesetround. Zuvor wählte das Rundungsverhalten immer aus FE_TONEAREST . Diese Änderung betrifft nur Programme, die mit Visual Studio 2019, Version 16.2 und höher erstellt wurden. Wenn Sie das ältere Gleitkomma-Rundungsverhalten verwenden möchten, verknüpfen Sie die Verknüpfung mit "legacy_stdio_float_rounding.obj".

Hinweis

Um sicherzustellen, dass genügend Platz für das abschließende Nullzeichen vorhanden ist, achten Sie darauf, dass count kleiner als die Pufferlänge ist oder verwenden Sie _TRUNCATE.

In C++ wird die Verwendung dieser Funktionen durch Vorlagenüberladungen vereinfacht; die Überladungen können automatisch Rückschlüsse auf die Pufferlänge ziehen (wodurch kein Größenargument mehr angegeben werden muss), und sie können automatisch die älteren, nicht sicheren Funktionen durch ihre neueren, sicheren Entsprechungen ersetzen. Weitere Informationen finden Sie unter "Sichere Vorlagenüberladungen".

Tipp

Wenn sie einen nicht definierten externen _vsnprintf_s Fehler erhalten und die universelle C-Runtime verwenden, fügen Sie der Gruppe der zu verknüpfenden Bibliotheken hinzu legacy_stdio_definitions.lib . Die universelle C-Runtime exportiert diese Funktion nicht direkt und wird stattdessen inline <stdio.h>definiert. Weitere Informationen finden Sie unter Übersicht über potenzielle Upgradeprobleme und Änderungen an der Konformität von Visual Studio 2015.

Generische Textroutinzuordnungen

TCHAR.H Routine	_UNICODE und _MBCS nicht definiert	_MBCS Definiert	_UNICODE Definiert
_vsntprintf_s	_vsnprintf_s	_vsnprintf_s	_vsnwprintf_s
_vsntprintf_s_l	_vsnprintf_s_l	_vsnprintf_s_l	_vsnwprintf_s_l

Anforderungen

Routine	Erforderlicher Header	Optionale Header
vsnprintf_s	<stdio.h> und <stdarg.h>	<varargs.h>*
_vsnprintf_s, _vsnprintf_s_l	<stdio.h> und <stdarg.h>	<varargs.h>*
_vsnwprintf_s, _vsnwprintf_s_l	<stdio.h> oder <wchar.h>, und <stdarg.h>	<varargs.h>*

* Erforderlich für UNIX V-Kompatibilität.

Weitere Informationen zur Kompatibilität finden Sie unter Kompatibilität.

Beispiel

// crt_vsnprintf_s.cpp
#include <stdio.h>
#include <wtypes.h>

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

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

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

Siehe auch

Stream-E/A
vprintf-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