Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / C

snprintf — formátování s omezenou velikostí bufferu

snprintf zapisuje formátovaný text do bufferu se zadanou kapacitou. Z návratové hodnoty lze zjistit zkrácení; kapacita zahrnuje závěrečný nulový znak.

Verze: C23; repository compiler flag, production runtime not attested

Syntaxe

#include <stdio.h>
int snprintf(char * restrict s, size_t n, const char * restrict format, ...);

snprintf z <stdio.h> formátuje data do pole s. Pro n > 0 zapíše nejvýše n - 1 znaků a závěrečné \0. Uveď skutečnou dostupnou kapacitu bufferu, nikoli velikost ukazatele.

Nejprve zkontroluj result < 0: záporná návratová hodnota označuje chybu kódování. Jinak návratová hodnota udává požadovanou délku bez \0 a (unsigned int)result >= n znamená, že pro celý výsledek včetně \0 není dost místa. Každou nezápornou hodnotu typu int lze vyjádřit v typu unsigned int a implicitní převody při tomto porovnání obě hodnoty zachovají. Převod návratové hodnoty na size_t však může hodnotu větší než SIZE_MAX změnit a zakrýt tak zkrácení.

snprintf(NULL, 0, ...) nic nezapisuje a umožňuje vypočítat délku. Typy argumentů musí odpovídat formátu; kopírování mezi překrývajícími se objekty má nedefinované chování.

Příklady

#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;
}

Výsledek

buffer: abcd
required: 6
truncated

Kód a uvedený výstup byly ověřeny v izolovaném prostředí. Převod na `size_t` zde funguje, protože návratovou hodnotu `6` lze v tomto typu vyjádřit. V obecném případě použij porovnání s `unsigned int` popsané výše.

Zdroje