CKTIS / C
snprintf — formatowanie z limitem bufora
snprintf zapisuje sformatowany tekst w buforze o podanej pojemności. Wynik pozwala wykryć obcięcie tekstu; pojemność obejmuje końcowy znak zerowy.
Wersja: C23; repository compiler flag, production runtime not attested
Składnia
#include <stdio.h>
int snprintf(char * restrict s, size_t n, const char * restrict format, ...);snprintf z <stdio.h> formatuje dane do tablicy s. Dla n > 0 zapisuje najwyżej n - 1 znaków oraz końcowe \0. Podaj rzeczywistą pojemność dostępnego bufora, nie rozmiar wskaźnika.
Najpierw sprawdź result < 0: wynik ujemny oznacza błąd kodowania. W przeciwnym razie wynik to wymagana długość bez \0, a (unsigned int)result >= n oznacza, że nie ma miejsca na pełny wynik wraz z \0. Typ unsigned int mieści każdą nieujemną wartość typu int, a niejawne konwersje w tym porównaniu zachowują obie wartości. Rzutowanie wyniku na size_t może natomiast zmienić wartość większą niż SIZE_MAX i ukryć obcięcie tekstu.
snprintf(NULL, 0, ...) niczego nie zapisuje i pozwala obliczyć długość. Typy argumentów muszą odpowiadać formatowi; kopiowanie między nakładającymi się obiektami ma niezdefiniowane zachowanie.
Przykłady
#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;
}
Wynik
buffer: abcd required: 6 truncated
Kod i podany wynik zweryfikowano w odizolowanym środowisku. Rzutowanie na `size_t` działa w tym przykładzie, ponieważ zwrócona wartość `6` mieści się w tym typie. W ogólnym przypadku użyj porównania z `unsigned int` opisanego powyżej.