_snprintf_s
, _snprintf_s_l
, _snwprintf_s
, _snwprintf_s_l
Schreibt formatierte Daten in eine Zeichenfolge. Diese Funktionen sind Versionen von snprintf
, _snprintf
, _snprintf_l
, _snwprintf
mit _snwprintf_l
Sicherheitsverbesserungen, die in den Sicherheitsfeatures im CRT beschrieben werden.
Syntax
int _snprintf_s(
char *buffer,
size_t sizeOfBuffer,
size_t count,
const char *format [,
argument] ...
);
int _snprintf_s_l(
char *buffer,
size_t sizeOfBuffer,
size_t count,
const char *format,
_locale_t locale [,
argument] ...
);
int _snwprintf_s(
wchar_t *buffer,
size_t sizeOfBuffer,
size_t count,
const wchar_t *format [,
argument] ...
);
int _snwprintf_s_l(
wchar_t *buffer,
size_t sizeOfBuffer,
size_t count,
const wchar_t *format,
_locale_t locale [,
argument] ...
);
template <size_t size>
int _snprintf_s(
char (&buffer)[size],
size_t count,
const char *format [,
argument] ...
); // C++ only
template <size_t size>
int _snwprintf_s(
wchar_t (&buffer)[size],
size_t count,
const wchar_t *format [,
argument] ...
); // C++ only
Parameter
buffer
Speicherort für die Ausgabe.
sizeOfBuffer
Die Größe des Speicherorts für die Ausgabe. Größe in Byte für die Funktionen, die verwendet char
werden, und Wörter für diejenigen, die verwendet wchar_t
werden.
count
Maximale Anzahl der zu schreibenden Zeichen. Für die Funktionen, die verwendet wchar_t
werden, ist es die maximale Anzahl von breiten Zeichen, die geschrieben werden sollen. Oder _TRUNCATE
.
format
Formatsteuerzeichenfolge.
argument
Optionale Argumente.
locale
Das zu verwendende Gebietsschema.
Rückgabewert
Die Anzahl der geschriebenen Zeichen, nicht einschließlich des Beendens NULL
. Wenn ein Ausgabefehler auftritt, wird ein negativer Wert zurückgegeben. Ausführliche Informationen finden Sie in der Verhaltenszusammenfassung .
Hinweise
Die _snprintf_s
Funktion formatiert und speichert count
oder weniger Zeichen in buffer
und fügt eine Beendigung NULL
an. Jedes Argument (falls vorhanden) wird entsprechend der jeweiligen Formatangabe in format
konvertiert und ausgegeben. Die Formatierung ist mit der printf
Familie der Funktionen konsistent; siehe Formatspezifikationssyntax: printf
und wprintf
Funktionen. Wenn der Kopiervorgang zwischen Zeichenfolgen ausgeführt wird, die sich überschneiden, ist das Verhalten nicht definiert.
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 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 | 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 einschließlich des Beendens NULL . |
Nicht zutreffend | Nein |
Codierungsfehler während der Formatierung | Wenn die Verarbeitung des Zeichenfolgenbezeichners s oder S der Z Formatierungsspezifikation beendet wird. |
-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 sizeOfBuffer == 0 count == 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. | -1 | EINVAL (22) |
Ja |
count == 0 |
A NULL wird am Anfang des Puffers platziert. |
-1 | 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 und eine Beendigung NULL wird angefügt. |
-1 | Nicht zutreffend | Nein |
count >= sizeOfBuffer und len < sizeOfBuffer |
Alle Daten werden mit einer Beendigung NULL geschrieben. |
Die Anzahl der geschriebenen Zeichen. | Nicht zutreffend | Nein |
count >= sizeOfBuffer und len >= sizeOfBuffer count != _TRUNCATE |
Wenn die Ausführung fortgesetzt wird, nachdem ein ungültiger Parameterhandler ausgeführt wird, wird festgelegt errno , festgelegt buffer[0] == NULL und ein negativer Wert zurückgegeben. |
-1 | ERANGE (34) |
Ja |
count == _TRUNCATE und len >= sizeOfBuffer |
Schreibt so viel der Zeichenfolge, wie es passt buffer , und eine Beendigung NULL . |
-1 | Nicht zutreffend | Nein |
count == _TRUNCATE und len < sizeOfBuffer |
Schreibt die gesamte Zeichenfolge buffer mit einem Beenden NULL in . |
Anzahl der geschriebenen Zeichen, nicht einschließlich des Beendens NULL . |
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_errlist
und _sys_nerr
._doserrno
Wichtig
Stellen Sie sicher, dass format
keine benutzerdefinierte Zeichenfolge ist.
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".
_snwprintf_s
ist eine Breitzeichen-Version von _snprintf_s
. Die Zeigerargumente zu _snwprintf_s
sind Breitzeichen-Zeichenfolgen. Die Erkennung von Codierungsfehlern in _snwprintf_s
unterscheidet sich möglicherweise von der in _snprintf_s
. Genau wie swprintf_s
schreibt _snwprintf_s
die Ausgabe in eine Zeichenfolge anstatt in ein Ziel vom Typ FILE
.
Die Versionen dieser Funktionen mit dem _l
-Suffix sind beinahe identisch, verwenden jedoch den ihnen übergebenen Gebietsschemaparameter anstelle des aktuellen Threadgebietsschemas.
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".
Generische Textroutinzuordnungen
Tchar.h Routine |
_UNICODE und _MBCS nicht definiert |
_MBCS Definiert |
_UNICODE Definiert |
---|---|---|---|
_sntprintf_s |
_snprintf_s |
_snprintf_s |
_snwprintf_s |
_sntprintf_s_l |
_snprintf_s_l |
_snprintf_s_l |
_snwprintf_s_l |
Anforderungen
Routine | Erforderlicher Header |
---|---|
_snprintf_s , _snprintf_s_l |
<stdio.h> |
_snwprintf_s , _snwprintf_s_l |
<stdio.h> oder <wchar.h> |
Weitere Informationen zur Kompatibilität finden Sie unter Kompatibilität.
Beispiel
// crt_snprintf_s.cpp
// compile with: /MTd
// These #defines enable secure template overloads
// (see last part of Examples() below)
#define _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES 1
#define _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES_COUNT 1
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <crtdbg.h> // For _CrtSetReportMode
#include <errno.h>
// This example uses a 10-byte destination buffer.
int snprintf_s_tester( const char * fmt, int x, size_t count )
{
char dest[10];
printf( "\n" );
if ( count == _TRUNCATE )
printf( "%zd-byte buffer; truncation semantics\n",
_countof(dest) );
else
printf( "count = %zd; %zd-byte buffer\n",
count, _countof(dest) );
int ret = _snprintf_s( dest, _countof(dest), count, fmt, x );
printf( " new contents of dest: '%s'\n", dest );
return ret;
}
void Examples()
{
// formatted output string is 9 characters long: "<<<123>>>"
snprintf_s_tester( "<<<%d>>>", 121, 8 );
snprintf_s_tester( "<<<%d>>>", 121, 9 );
snprintf_s_tester( "<<<%d>>>", 121, 10 );
printf( "\nDestination buffer too small:\n" );
snprintf_s_tester( "<<<%d>>>", 1221, 10 );
printf( "\nTruncation examples:\n" );
int ret = snprintf_s_tester( "<<<%d>>>", 1221, _TRUNCATE );
printf( " truncation %s occur\n", ret == -1 ? "did"
: "did not" );
ret = snprintf_s_tester( "<<<%d>>>", 121, _TRUNCATE );
printf( " truncation %s occur\n", ret == -1 ? "did"
: "did not" );
printf( "\nSecure template overload example:\n" );
char dest[10];
_snprintf( dest, 10, "<<<%d>>>", 12321 );
// With secure template overloads enabled (see #defines
// at top of file), the preceding line is replaced by
// _snprintf_s( dest, _countof(dest), 10, "<<<%d>>>", 12345 );
// Instead of causing a buffer overrun, _snprintf_s invokes
// the invalid parameter handler.
// If secure template overloads were disabled, _snprintf would
// write 10 characters and overrun the dest buffer.
printf( " new contents of dest: '%s'\n", dest );
}
void myInvalidParameterHandler(
const wchar_t* expression,
const wchar_t* function,
const wchar_t* file,
unsigned int line,
uintptr_t pReserved)
{
wprintf(L"Invalid parameter handler invoked: %s\n", expression);
}
int main( void )
{
_invalid_parameter_handler oldHandler, newHandler;
newHandler = myInvalidParameterHandler;
oldHandler = _set_invalid_parameter_handler(newHandler);
// Disable the message box for assertions.
_CrtSetReportMode(_CRT_ASSERT, 0);
Examples();
}
count = 8; 10-byte buffer
new contents of dest: '<<<121>>'
count = 9; 10-byte buffer
new contents of dest: '<<<121>>>'
count = 10; 10-byte buffer
new contents of dest: '<<<121>>>'
Destination buffer too small:
count = 10; 10-byte buffer
Invalid parameter handler invoked: ("Buffer too small", 0)
new contents of dest: ''
Truncation examples:
10-byte buffer; truncation semantics
new contents of dest: '<<<1221>>'
truncation did occur
10-byte buffer; truncation semantics
new contents of dest: '<<<121>>>'
truncation did not occur
Secure template overload example:
Invalid parameter handler invoked: ("Buffer too small", 0)
new contents of dest: ''
Siehe auch
Stream-E/A
sprintf
, _sprintf_l
, swprintf
, _swprintf_l
, __swprintf_l
fprintf
, _fprintf_l
, fwprintf
, _fwprintf_l
printf
, _printf_l
, wprintf
, _wprintf_l
scanf
, _scanf_l
, wscanf
, _wscanf_l
sscanf
, _sscanf_l
, swscanf
, _swscanf_l
vprintf
-Funktionen
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für