CKTIS / C
snprintf — Formatierung mit begrenztem Puffer
snprintf schreibt formatierten Text in einen Puffer mit angegebener Kapazität. Anhand des Rückgabewerts lässt sich eine Kürzung erkennen; die Kapazität schließt das abschließende Nullzeichen ein.
Version: C23; repository compiler flag, production runtime not attested
Syntax
#include <stdio.h>
int snprintf(char * restrict s, size_t n, const char * restrict format, ...);snprintf aus <stdio.h> formatiert Daten in das Array s. Für n > 0 schreibt die Funktion höchstens n - 1 Zeichen sowie das abschließende \0. Gib die tatsächlich verfügbare Pufferkapazität an, nicht die Größe des Zeigers.
Prüfe zuerst result < 0: Ein negativer Rückgabewert weist auf einen Kodierungsfehler hin. Andernfalls entspricht der Rückgabewert der erforderlichen Länge ohne \0, und (unsigned int)result >= n bedeutet, dass der Platz für das vollständige Ergebnis einschließlich \0 nicht ausreicht. Jeder nichtnegative Wert vom Typ int ist in unsigned int darstellbar, und die impliziten Umwandlungen bei diesem Vergleich erhalten beide Werte. Eine Umwandlung des Rückgabewerts in size_t kann dagegen einen Wert über SIZE_MAX verändern und so eine Kürzung verdecken.
snprintf(NULL, 0, ...) schreibt nichts und ermöglicht die Berechnung der Länge. Die Argumenttypen müssen zum Format passen; das Kopieren zwischen überlappenden Objekten führt zu undefiniertem Verhalten.
Beispiele
#include <stdio.h>
int main(void)
{
char buf[5];
int result = snprintf(buf, sizeof buf, "%s", "abcdef");
if (result < 0) {
puts("encoding error");
return 1;
}
printf("buffer: %s\nrequired: %d\n", buf, result);
if ((size_t)result >= sizeof buf) {
puts("truncated");
}
return 0;
}
Ergebnis
buffer: abcd required: 6 truncated
Der Code und die angegebene Ausgabe wurden in einer isolierten Umgebung überprüft. Die Umwandlung in `size_t` funktioniert hier, weil der Rückgabewert `6` in diesem Typ darstellbar ist. Verwende im Allgemeinen den oben beschriebenen Vergleich mit `unsigned int`.