C Standard Library

C <stdio.h> - vfprintf() Function



The C <stdio.h> vfprintf() function writes the C string pointed by format to the stream. If format includes format specifiers (sub-sequences beginning with %), the variable argument list identified by vlist are formatted and inserted in the resulting string replacing their respective specifiers.

Internally, the function retrieves arguments from the list identified by vlist as if va_start was used on it, and thus the state of vlist is likely altered by the call.

In any case, vlist should have been initialized by va_start at some point before the call, and it is expected to be released by va_end at some point after the call.

Syntax

int vfprintf ( FILE * stream, const char * format, va_list vlist );

Parameters

stream Specify a pointer to a FILE object that specifies an output stream.
format

Specify the format string. The possible values of %specifier are:

%specifierDescription
%%Returns a percent sign
%cCharacter
%dSigned decimal integer (negative, zero or positive)
%iSigned decimal integer (negative, zero or positive)
%uUnsigned decimal number (zero or positive)
%eScientific notation using a lowercase (e.g. 1.2e+3)
%EScientific notation using a uppercase (e.g. 1.2E+3)
%fDecimal floating point, lowercase
%FDecimal floating point, uppercase
%gShorter of %e and %f
%GShorter of %E and %f
%pPointer address
%oUnsigned octal
%sString of characters
%xUnsigned hexadecimal integer (lowercase letters)
%XUnsigned hexadecimal integer (uppercase letters)
%aHexadecimal floating point (lowercase letters)
%AHexadecimal floating point (uppercase letters)
%nNothing is printed. Returns the number of characters written so far by this call to the function. The result is written to the value pointed to by the argument. The corresponding argument must be a pointer to a signed int. The specification may not contain any flag, width, or precision. See the example below.

Additional format values can be placed between the % and the specifier (e.g. %.3f) also known as sub-specifier. These sub-specifier are:

  • Flags:
    • - : Left-justify within the given field width. Right justification is the default.
    • + : Prefix positive numbers with a plus sign +. By default only negative are prefixed with a negative sign.
    • (space) : If no sign is going to be written, a blank space is inserted before the value.
    • # : When used with o, x or X specifiers the value is preceded with 0, 0x or 0X respectively for values different than zero.
      When used with a, A, e, E, f, F, g or G specifiers, it forces the written output to contain a decimal point even if no more digits follow. By default, no decimal point is written if no digits follow.
    • 0 : Only left-pads numbers with zeros instead of spaces when padding is specified.
  • Width: An integer or * that specifies minimum field width. In the case when * is used, the width is not specified in the format string, but as an additional integer value argument preceding the argument that has to be formatted. If the value to be printed is shorter than the width, the result is padded with blank spaces. (Note: This is the minimum width: The value is never truncated.)
  • Precision: Period . followed by an integer or *. In the case when * is used, the precision is not specified in the format string, but as an additional integer value argument preceding the argument that has to be converted. If the value of this argument is negative, it is ignored. If neither a number nor * is used, the precision is taken as zero.
    • For d, i, o, u, x and X specifiers: It signifies the minimum number of digits.
    • For a, A, e, E, f and F specifiers: It signifies the number of decimal digits.
    • For g and G specifiers: It signifies the maximum number of significant digits.
    • For s specifier: It specifies a cutoff point, setting maximum number of characters.
  • Length: Modifies the length of the data type. For example - %i is used for signed decimal integer, with ll length sub-specifier it becomes %lli which can be used for long long int data type. Here is the complete list of length sub-specifier.

Note: If multiple additional format values are provided, they must be in %[flags][width][.precision][length]specifier order.

vlist Specify a variable argument list containing the data to print initialized with va_start.

Return Value

Returns the total number of characters written on success (not including the terminating null character). If a writing error occurs, sets the error indicator ferror() and a negative number is returned. If a multibyte character encoding error occurs while writing wide characters, errno is set to EILSEQ and a negative number is returned.

Example: vfprintf() example

In the example below shows the usage of vfprintf() function.

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

void WriteFormatted( FILE * stream, const char * format, ... ) {
  va_list args;
  va_start(args, format);
  vfprintf(stream, format, args);
  va_end(args);
}

int main () {
  //open the file in write and read mode
  FILE *pFile = fopen("test.txt", "w+");

  WriteFormatted(pFile, "Calling with %d variable argument.\n", 1);
  WriteFormatted(pFile, "Calling with %d variable %s.\n", 2, "arguments");
  WriteFormatted(pFile, "Calling with %d %s %s.\n", 3, "variable", "arguments");

  //set the position to the start
  rewind(pFile);

  //display the content of the file
  int c = getc(pFile);
  while(c != EOF) {
    putchar(c);
    c = getc(pFile);
  }

  //close the file
  fclose (pFile);

  return 0;
}

The output of the above code will be:

Calling with 1 variable argument.
Calling with 2 variable arguments.
Calling with 3 variable arguments.


Length sub-specifier

Specifiers
lengthd iu o x Xf F e E g G a Acspn
(none)intunsigned intdoubleintchar*void*int*
hhsigned charunsigned char signed char*
hshort intunsigned short int short int*
llong intunsigned long intdoublewint_twchar_t* long int*
lllong long intunsigned long long int long long int*
jintmax_tuintmax_t intmax_t*
zsize_tsize_t size_t*
tptrdiff_tptrdiff_t ptrdiff_t*
L long double

See <cinttypes> for the specifiers for extended types.


❮ C <stdio.h> Library