Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / C

snprintf — formatage avec une limite de tampon

snprintf écrit du texte formaté dans un tampon de capacité spécifiée. Sa valeur de retour permet de détecter une troncature ; la capacité inclut le caractère nul final.

Version : 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 de <stdio.h> formate des données dans le tableau s. Pour n > 0, la fonction écrit au plus n - 1 caractères, suivis du \0 final. Indiquez la capacité réellement disponible du tampon, et non la taille du pointeur.

Vérifiez d’abord result < 0 : une valeur de retour négative signale une erreur d’encodage. Sinon, la valeur de retour correspond à la longueur requise sans \0, et (unsigned int)result >= n indique que l’espace disponible ne suffit pas pour le résultat complet, \0 compris. Toute valeur non négative de type int est représentable en unsigned int, et les conversions implicites de cette comparaison préservent les deux valeurs. En revanche, convertir la valeur de retour en size_t peut modifier une valeur supérieure à SIZE_MAX et masquer une troncature.

snprintf(NULL, 0, ...) n’écrit rien et permet de calculer la longueur. Les types des arguments doivent correspondre au format ; copier entre des objets qui se chevauchent entraîne un comportement indéfini.

Exemples

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

Résultat

buffer: abcd
required: 6
truncated

Le code et la sortie indiquée ont été vérifiés dans un environnement isolé. La conversion en `size_t` fonctionne ici, car la valeur renvoyée `6` est représentable dans ce type. En général, utilisez la comparaison avec `unsigned int` décrite ci-dessus.

Sources