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

CKTIS / C

vsnprintf — formater une va_list dans un tampon de capacité limitée

vsnprintf formate les arguments fournis par une va_list. Elle limite les écritures à la capacité du tampon, et la longueur renvoyée permet de détecter une sortie tronquée.

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

Syntaxe

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

vsnprintf fonctionne comme snprintf, mais accepte une va_list au lieu d’arguments .... Elle permet de créer des fonctions d’encapsulation du formatage.

n correspond à la capacité du tampon en octets, y compris le \0 final. Pour n > 0, la fonction écrit au plus n - 1 octets de sortie et un terminateur. Pour n == 0, elle n’écrit rien ; s peut être NULL.

Le résultat r est la longueur nécessaire sans le terminateur ; une valeur négative indique une erreur d’encodage. Vérifiez d’abord r < 0. Si r est positif ou nul et que n > 0, la condition (unsigned int)r >= n indique que la sortie a été tronquée. La conversion en unsigned int préserve toute valeur int positive ou nulle, même si size_t ne peut pas la représenter.

Initialisez la liste avec va_start et terminez-la avec va_end ; la fonction ne s’en charge pas. Pour un autre passage, utilisez va_copy avant de consommer la liste et terminez également la copie. Les types des arguments doivent correspondre au format ; des objets copiés qui se chevauchent entraînent un comportement indéfini. Passez le texte non fiable comme donnée pour %s, et non comme format.

Exemples

#include <stdarg.h>
#include <stdio.h>

static int format_to(char *dst, size_t cap, const char *fmt, ...)
{
    va_list args;
    va_start(args, fmt);
    int result = vsnprintf(dst, cap, fmt, args);
    va_end(args);
    return result;
}

int main(void)
{
    char buf[8];
    int result = format_to(buf, sizeof buf, "%s:%d", "item", 12345);
    if (result < 0) {
        return 1;
    }
    printf("text=%s\nneeded=%d\ntruncated=%d\n",
           buf, result, (unsigned int)result >= sizeof buf);
    return 0;
}

Résultat

text=item:12
needed=10
truncated=1

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources