vsnprintf_s, _vsnprintf_s, _vsnprintf_s_l, _vsnwprintf_s, _vsnwprintf_s_l

Artikel
02/26/2013

Write formatierte Ausgabe mithilfe eines Zeigers auf eine Liste von Argumenten.Dies sind Versionen von vsnprintf, _vsnprintf, _vsnprintf_l, _vsnwprintf, _vsnwprintf_l mit beschrieben, wie unter Security Enhancements in Sicherheitsfeatures im CRT.

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 buffer für die Ausgabe in Bytes.
count
Maximale Anzahl zu schreibende Zeichen (ohne das abschließende NULL-Zeichen) oder _TRUNCATE.
format
Formatangabe.
argptr
Zeiger auf die Liste der Argumente.
locale
Das zu verwendende Gebietsschema.

Weitere Informationen finden Sie unter Formatangaben.

Rückgabewert

vsnprintf_s,_vsnprintf_sund _vsnwprintf_sgeben die Anzahl der geschriebenen Zeichen, ohne das abschließende NULL-Zeichen oder einen negativen Wert zurück, wenn ein Ausgabefehler auftritt.vsnprintf_s ist mit _vsnprintf_sidentisch.vsnprintf_s wird bereitgestellt, um die Kompatibilität mit dem ANSI-Standard enthalten._vnsprintf wird aus Gründen der Abwärtskompatibilität beibehalten.

Wenn der Speicher, der die Daten und ein abschließendes NULL-Zeichen zu speichern sizeOfBuffererforderlich ist, ungültige Parameter überschreitet, wird der Ereignishandler aufgerufen, wie in Parametervalidierungbeschrieben, es sei denn, count_TRUNCATEist, in diesem Fall so weit wie in der Zeichenfolge geschrieben wird buffer entspricht, und -1 (null) zurückgegeben.Wenn die Ausführung nach dem ungültigen Parameter, wird für diese Funktionen buffer auf eine leere Zeichenfolge fest, und legen errno zu ERANGEreturn -1 fest.

Wenn bufferNULLformat oder ein Zeiger ist oder wenn count kleiner oder gleich null ist, wird der Ereignishandler aufgerufen. ungültige ParameterWenn die Ausführung fortgesetzt werden kann, darf dieses Features zu EINVAL und legen errno return -1.

Fehlerbedingungen

Condition	Return	errno
buffer istNULL	-1	EINVAL
format istNULL	-1	EINVAL
count <= 0	-1	EINVAL
sizeOfBuffer zu klein (und count ! = _TRUNCATE)	-1 ( buffer und auf eine leere Zeichenfolge festlegen)	ERANGE

Hinweise

Jede dieser Funktionen akzeptiert einen Zeiger auf eine Argumentliste, den Formaten und Schreibvorgänge für count Zeichen der angegebenen Daten im Arbeitsspeicher auf durch buffer gezeigten und fügt ein abschließendes NULL-Zeichen an.

Wenn count_TRUNCATEist, schreiben diese Funktionen so weit wie in der Zeichenfolge, bei der buffer Für des Lassen für ein abschließendes NULL-Zeichen passt.Wenn die gesamte Passung der Zeichenfolge NULL-Zeichen (mit abschließendem) in buffer, diese Funktionen die Anzahl der geschriebenen Zeichen zurück () ohne das abschließende NULL-Zeichen. Andernfalls geben diese Funktionen -1 zurück, um anzugeben, dass Abschneiden aufgetreten ist.

Die Versionen dieser Funktionen mit dem _l Suffix sind identisch, mit der Ausnahme, dass sie verwenden den Gebietsschemaparameter, der anstelle des aktuellen Threads gebietsschemas übergeben wird.

Sicherheitshinweis
Stellen Sie sicher, dass format keine benutzerdefinierte Zeichenfolge ist.Weitere Informationen finden Sie unter Vermeiden von Pufferüberläufen.

Hinweis
Um sicherzustellen, dass es sich um Platz für das abschließende NULL-Zeichen wird, stellen Sie sicher, dass count kleiner als die Pufferlänge ist, oder verwenden _TRUNCATE.

In C++ unter Verwendung dieser Funktionen wird von Vorlagen Operatoren vereinfacht. Die Überladungen können die Pufferlänge (die Anforderung automatisch beseitigend ableiten, die ein Argument angegeben) und können nicht-sicheren, die älteren Funktionen über ihre Äquivalente sicheren, aktuelleren automatisch ersetzen.Weitere Informationen finden Sie unter Speichern Sie Vorlagen-Überladungen.

Zuweisung generischer Textroutinen

TCHAR.H-Routine	_UNICODE & _MBCS nicht definiert	_MBCS definieren	_UNICODE definiert
_vsntprintf_s	_vsnprintf_s	_vsnprintf_s	_vsnwprintf_s
_vsntprintf_s_l	_vsnprintf_s_l	_vsnprintf_s_l	_vsnwprintf_s_l

.NET Framework-Entsprechung

Nicht zutreffend. Um die Standard-C-Funktion aufrufen, verwenden Sie PInvoke. Weitere Informationen finden Sie unter Plattformaufruf-Beispiele.

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> als auch <stdarg.h>	<varargs.h> *

* Für Kompatibilität UNIX V.

Um Kompatibilität zusätzlichen Informationen finden Sie unter Kompatibilität in der Einführung.

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, sizeof(buff), _TRUNCATE, formatstring, args);
   printf("nSize: %d, buff: %s\n", nSize, buff);
}

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