Freigeben über

sprintf_s, , _sprintf_s_lswprintf_s_swprintf_s_l

  • Artikel

Schreiben Sie formatierte Daten in eine Zeichenfolge. Diese Funktionen sind Versionen von sprintf, _sprintf_l, swprintf, _swprintf_lmit __swprintf_l Sicherheitsverbesserungen, wie in sicherheitsfeatures in der CRT beschrieben.

Syntax

int sprintf_s(
   char *buffer,
   size_t sizeOfBuffer,
   const char *format,
   ...
);
int _sprintf_s_l(
   char *buffer,
   size_t sizeOfBuffer,
   const char *format,
   _locale_t locale,
   ...
);
int swprintf_s(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   const wchar_t *format,
   ...
);
int _swprintf_s_l(
   wchar_t *buffer,
   size_t sizeOfBuffer,
   const wchar_t *format,
   _locale_t locale,
   ...
);
template <size_t size>
int sprintf_s(
   char (&buffer)[size],
   const char *format,
   ...
); // C++ only
template <size_t size>
int swprintf_s(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   ...
); // C++ only

Parameter

buffer
Speicherort für die Ausgabe

sizeOfBuffer
Die maximale Anzahl der zu speichernden Zeichen.

format
Formatsteuerzeichenfolge

...
Optionale Argumente, die formatiert werden müssen

locale
Das zu verwendende Gebietsschema.

Weitere Informationen finden Sie unter Formatspezifikations-Syntax.

Rückgabewert

Die Anzahl der geschriebenen Zeichen oder -1, wenn ein Fehler aufgetreten ist. Wenn buffer oder format ein NULL-Zeiger ist, geben sprintf_s und swprintf_s -1 zurück und stellen errno auf EINVAL ein.

sprintf_s gibt die in buffergespeicherte Byteanzahl zurück. Das beendende NULL-Zeichen wird dabei nicht mitgezählt. swprintf_s gibt die Anzahl der in buffer gespeicherten Breitzeichen zurück. Das beendende NULL-Breitzeichen wird dabei nicht mitgezählt.

Hinweise

Die sprintf_s-Funktion formatiert und speichert eine Reihe von Zeichen und Werte in buffer. Jedes argument (falls vorhanden) wird entsprechend der jeweiligen Formatangabe in formatkonvertiert und ausgegeben. Das Format besteht aus normalen Zeichen und hat die gleiche Form und Funktion wie das format-Argument für printf. Ein NULL-Zeichen wird nach dem letzten geschriebenen Zeichen angefügt. Wenn der Kopiervorgang zwischen Zeichenfolgen ausgeführt wird, die sich überschneiden, ist das Verhalten nicht definiert.

Ein Hauptunterschied zwischen sprintf_s und sprintf besteht darin, dass sprintf_s die Formatzeichenfolge auf gültige Formatierungszeichen überprüft. Dagegen überprüft sprintf nur, ob es sich bei der Formatzeichenfolge oder beim Puffer um einen NULL -Zeiger handelt. Wenn eine überprüfung fehlschlägt, wird der ungültige Parameterhandler aufgerufen, wie in der Parameterüberprüfung beschrieben. Wenn die weitere Ausführung zugelassen wird, gibt die Funktion -1 zurück und stellt errno auf EINVALein.

Der andere Hauptunterschied zwischen sprintf_s und sprintf besteht darin, dass sprintf_s einen Längenparameter akzeptiert, der die Größe des Ausgabepuffers in den Zeichen angibt. Wenn der Puffer für den formatierten Text einschließlich abschließendem NULL-Zeichen zu klein ist, wird er auf eine leere Zeichenfolge festgelegt, indem ein NULL-Zeichen in buffer[0]gespeichert wird, und der Handler für ungültige Parameter wird aufgerufen. Im Gegensatz zu _snprintfgarantiert sprintf_s , dass der Puffer mit NULL endet (es sei denn, die Puffergröße ist gleich null).

swprintf_s ist eine Breitzeichen-Version von sprintf_s. Die Zeigerargumente zu swprintf_s sind Breitzeichen-Zeichenfolgen. Die Erkennung von Codierungsfehlern in swprintf_s kann sich von der Erkennung unterscheiden in sprintf_s. 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 die Pufferlänge automatisch ableiten, wodurch die Notwendigkeit zum Angeben eines Größenarguments ausgeschlossen wird. Und sie können ältere, nicht sichere Funktionen automatisch durch neuere, sicherere Entsprechungen ersetzen. Weitere Informationen finden Sie unter Secure Template Overloads.

Es gibt Versionen, die sprintf_s mehr Kontrolle darüber bieten, was passiert, wenn der Puffer zu klein ist. Weitere Informationen finden Sie unter _snprintf_s, , _snprintf_s_l, . _snwprintf_s_l_snwprintf_s

Wichtig

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 fesetroundfestgelegt 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`.

Mapping generischer Textroutinen

TCHAR.H-Routine _UNICODE und _MBCS nicht definiert _MBCS definiert _UNICODE definiert
_stprintf_s sprintf_s sprintf_s swprintf_s
_stprintf_s_l _sprintf_s_l _sprintf_s_l _swprintf_s_l

Anforderungen

Routine Erforderlicher Header
sprintf_s, _sprintf_s_l C: <stdio.h>

C++: <cstdio> oder <stdio.h>
swprintf_s, _swprintf_s_l C: <stdio.h> oder <wchar.h>

C++: <cstdio>, <cwchar>, <stdio.h> oder <wchar.h>

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

Beispiel: Verwenden von sprintf_s zum Formatieren von Daten

// crt_sprintf_s.c
// This program uses sprintf_s to format various
// data and place them in the string named buffer.
//

#include <stdio.h>

int main( void )
{
   char  buffer[200], s[] = "computer", c = 'l';
   int   i = 35, j;
   float fp = 1.7320534f;

   // Format and print various data:
   j  = sprintf_s( buffer, 200,     "   String:    %s\n", s );
   j += sprintf_s( buffer + j, 200 - j, "   Character: %c\n", c );
   j += sprintf_s( buffer + j, 200 - j, "   Integer:   %d\n", i );
   j += sprintf_s( buffer + j, 200 - j, "   Real:      %f\n", fp );

   printf_s( "Output:\n%s\ncharacter count = %d\n", buffer, j );
}

Output:
   String:    computer
   Character: l
   Integer:   35
   Real:      1.732053

character count = 79

Beispiel: Fehlercodebehandlung

// crt_swprintf_s.c
// wide character example
// also demonstrates swprintf_s returning error code
#include <stdio.h>

int main( void )
{
   wchar_t buf[100];
   int len = swprintf_s( buf, 100, L"%s", L"Hello world" );
   printf( "wrote %d characters\n", len );
   len = swprintf_s( buf, 100, L"%s", L"Hello\xffff world" );
   // swprintf_s fails because string contains WEOF (\xffff)
   printf( "wrote %d characters\n", len );
}

wrote 11 characters
wrote -1 characters

Siehe auch

Stream-E/A
fprintf, , _fprintf_lfwprintf_fwprintf_l
printf, , _printf_lwprintf_wprintf_l
sprintf, , _sprintf_lswprintf, , _swprintf_l__swprintf_l
scanf, , _scanf_lwscanf_wscanf_l
sscanf, , _sscanf_lswscanf_swscanf_l
vprintf -Funktionen