Fonctions fprintf, printf et sprintf

La vidéo

Entête à inclure

#include <stdio.h>  // <cstdio> en C++

Fonctions fprintf, printf et sprintf

int fprintf( FILE * stream, const char *format, ... );                       // Avant C99
int fprintf( FILE * restrict stream, const char * restrict format, ... );    // A partir de C99

int printf( const char *format, ... );                                       // Avant C99
int printf( const char * restrict format, ... );                             // A partir de C99

int sprintf( char * buffer, const char *format, ... );                       // Avant C99
int sprintf( char * restrict buffer, const char * restrict format, ... );    // A partir de C99

Ces trois fonctions sont à la fois proches et différentes. Le point commun, c'est qu'elles permettent toutes de formater des données à partir d'un langage de formatage simple et efficace. Par contre, la chaîne formatée n'est pas forcément envoyées dans un stream (du moins pour sprintf).

La fonction fprintf envoie la chaîne formatée dans un flux de caractère. En réalité, la fonction printf est très proche de la précédente dans le sens ou le flux est imposé : il s'agit de stdout. Par contre, sprintf stocke la chaîne formatée en mémoire dans un buffer pré-alloué.

Comment fonctionne le langage de formatage ? En fait c'est relativement simple : une chaîne de caractères définie des points d'injections pour les paramètres qui sont passés à la suite du paramètres de format. Ces points d'injections sont typés et éventuellement formatés. Par exemple, le format "[%d/%d]" spécifie qu'on cherche à injecter deux paramètres de type entier à la gauche et à la droite du caractère /. Ainsi, l'appel printf("[%d/%d]", 3, 4) affichera la chaîne [3/4] sur stdout.

Le tableau suivant vous propose quelques syntaxes de points d'injection relativement classiques. Vous pouvez bien entendu cumuler autant de points d'injections dans votre format que nécessaire (pour peu, bien entendu, que vous passiez ensuite les valeurs attendues en paramètres). Voici quelques exemples de formats.

%d

%3d

%03d

%ld

%lu

%x

%X

%f

%lf

%5.2lf

%g

%c

%s

%10s

%-10s

%p

Paramètres

• stream : représente le flux sur lequel produire la chaîne de caractères formatée.
• format : représente le format à utiliser pour générer la chaîne de caractères.
• buffer : ce paramètre, utilisé avec la fonction sprintf, permet de spécifier l'emplacement mémoire dans lequel stocker la nouvelle chaîne formatée à produire.

Valeur de retour

Dans tous les cas, soit le nombre de caractères produit dans la chaîne formatée vous sera renvoyée, soit, en cas d'erreur, la valeur EOF sera renvoyée. Il vous faudra alors consulter la variable errno pour obtenir de plus amples informations sur l'erreur constatée.

Exemple de code

#include <stdio.h>
#include <stdlib.h>

int main( int argc, char * argv[] ) {
    
    FILE * inputFile;
    
    argc--;   argv++;
    
    if ( argc == 0 ) {
        printf( "Usage: sample filename...\n" );
        exit( 0 );
    }
    
    inputFile = fopen( argv[0], "a" );
    if ( inputFile == NULL ) {
        fprintf( stderr, "Cannot open file %s\n", argv[0] );
        exit( 0 );
    }
    
    fprintf( inputFile, "Appending a new message in the file\n" );

    fclose( inputFile );
        
    return 0;
}

Sujets connexes