CKTIS / C
snprintf — formatteren met een bufferlimiet
snprintf schrijft opgemaakte tekst naar een buffer met een opgegeven capaciteit. Aan de retourwaarde is afkapping te herkennen; de capaciteit is inclusief het afsluitende nulteken.
Versie: 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 uit <stdio.h> formatteert gegevens in array s. Bij n > 0 schrijft de functie maximaal n - 1 tekens, plus de afsluitende \0. Geef de werkelijk beschikbare buffercapaciteit op, niet de grootte van de pointer.
Controleer eerst result < 0: een negatieve retourwaarde duidt op een coderingsfout. Anders is de retourwaarde de vereiste lengte, exclusief \0, en betekent (unsigned int)result >= n dat er onvoldoende ruimte is voor het volledige resultaat inclusief \0. Elke niet-negatieve int-waarde past in unsigned int, en de impliciete conversies bij deze vergelijking laten beide waarden ongewijzigd. Een conversie van de retourwaarde naar size_t kan daarentegen een waarde groter dan SIZE_MAX veranderen en afkapping verbergen.
snprintf(NULL, 0, ...) schrijft niets en maakt het mogelijk de lengte te berekenen. De argumenttypen moeten overeenkomen met het format; kopiëren tussen overlappende objecten leidt tot ongedefinieerd gedrag.
Voorbeelden
#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;
}
Resultaat
buffer: abcd required: 6 truncated
De code en de opgegeven uitvoer zijn geverifieerd in een geïsoleerde omgeving. De conversie naar `size_t` werkt hier omdat de retourwaarde `6` in dat type past. Gebruik in het algemeen de hierboven beschreven vergelijking met `unsigned int`.