Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / C

snprintf — formatação com limite de buffer

snprintf escreve texto formatado num buffer com capacidade especificada. O valor devolvido permite detetar truncagem; a capacidade inclui o carácter nulo final.

Versão: C23; repository compiler flag, production runtime not attested

Sintaxe

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

snprintf de <stdio.h> formata dados no array s. Para n > 0, escreve, no máximo, n - 1 caracteres e o \0 final. Indique a capacidade realmente disponível do buffer, não o tamanho do ponteiro.

Verifique primeiro result < 0: um valor devolvido negativo indica um erro de codificação. Caso contrário, o valor devolvido é o comprimento necessário, sem contar \0, e (unsigned int)result >= n indica que não há espaço suficiente para o resultado completo, incluindo \0. Todos os valores não negativos de tipo int são representáveis em unsigned int, e as conversões implícitas nesta comparação preservam ambos os valores. Em contrapartida, converter o valor devolvido para size_t pode alterar um valor superior a SIZE_MAX e ocultar a truncagem.

snprintf(NULL, 0, ...) não escreve nada e permite calcular o comprimento. Os tipos dos argumentos têm de corresponder ao formato; copiar entre objetos sobrepostos tem comportamento indefinido.

Exemplos

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

Resultado

buffer: abcd
required: 6
truncated

O código e a saída indicada foram verificados num ambiente isolado. A conversão para `size_t` funciona neste exemplo porque o valor devolvido, `6`, é representável nesse tipo. Em geral, use a comparação com `unsigned int` descrita acima.

Fontes