Name

Library

Synopsis

Return values

The functions return the number of wide characters written, excluding the terminating null wide character in case of the functions swprintf , snwprintf , vswprintf and vsnwprintf.

They return -1 when an error occurs.

Detailed description

These functions write the output under the control of a format string that specifies how subsequent arguments (or arguments accessed via the variable-length argument facilities of stdarg) are converted for output.

These functions return the number of characters printed (not including the trailing ‘\0’ used to end output to strings).

The swprintf , snwprintf , vswprintf and vsnwprintf functions will fail if n or more wide characters were requested to be written.

Note :

1. swprintf and snwprintf can be used interchangeably.

2. vswprintf and vsnwprintf can be used interchangeably.

The format string is composed of zero or more directives: ordinary characters (not %), which are copied unchanged to the output stream; and conversion specifications, each of which results in fetching zero or more subsequent arguments. Each conversion specification is introduced by the % character. The arguments must correspond properly (after type promotion) with the conversion specifier. After the %, the following appear in sequence:

• An optional field, consisting of a decimal digit string followed by a $, specifying the next argument to access. If this field is not provided, the argument following the last argument accessed will be used. Arguments are numbered starting at 1. If unaccessed arguments in the format string are interspersed with ones that are accessed the results will be indeterminate.
• Zero or more of the following flags:

  '#'	The value should be converted to an "alternate form". For c, d, i, n, p, s, and u conversions, this option has no effect. For o conversions, the precision of the number is increased to force the first character of the output string to a zero (except if a zero value is printed with an explicit precision of zero). For x and X conversions, a non-zero result has the string ‘0x’ (or ‘0X’ for X conversions) prepended to it. For a, A, e, E, f, F, g, and G conversions, the result will always contain a decimal point, even if no digits follow it (normally, a decimal point appears in the results of those conversions only if a digit follows). For g and G conversions, trailing zeros are not removed from the result as they would otherwise be.
  '0(zero)'	Zero padding. For all conversions except n, the converted value is padded on the left with zeros rather than blanks. If a precision is given with a numeric conversion ( d, i, o, u, i, x, and X), the 0 flag is ignored.
  '-'	A negative field width flag; the converted value is to be left adjusted on the field boundary. Except for n conversions, the converted value is padded on the right with blanks, rather than on the left with blanks or zeros. A - overrides a 0 if both are given.
  ' (space)'	A blank should be left before a positive number produced by a signed conversion ( a, A, d, e, E, f, F, g, G, or i).
  '+'	A sign must always be placed before a number produced by a signed conversion. A + overrides a space if both are used.
  '’'	Decimal conversions ( d, u, or i) or the integral portion of a floating point conversion ( f or F) should be grouped and separated by thousands using the non-monetary separator returned by localeconv.

• An optional decimal digit string specifying a minimum field width. If the converted value has fewer characters than the field width, it will be padded with spaces on the left (or right, if the left-adjustment flag has been given) to fill out the field width.
• An optional precision, in the form of a period . followed by an optional digit string. If the digit string is omitted, the precision is taken as zero. This gives the minimum number of digits to appear for d, i, o, u, x, and X conversions, the number of digits to appear after the decimal-point for a, A, e, E, f, and F conversions, the maximum number of significant digits for g and G conversions, or the maximum number of characters to be printed from a string for s conversions.
• An optional length modifier, that specifies the size of the argument. The following length modifiers are valid for the d, i, n, o, u, x, or X conversion:

  Modifier            d, i      o, u, x, X        n hh         signed char       unsigned char             signed char * h          short             unsigned short            short * l (ell)            long      unsigned long             long * ll (ell ell)       long long         unsigned long long        long long * j          intmax_t          uintmax_t         intmax_t * t          ptrdiff_t         (see note)        ptrdiff_t * z          (see note)        size_t            (see note) q (deprecated)             quad_t            u_quad_t          quad_t *

  Note: the t modifier, when applied to a o, u, x, or X conversion, indicates that the argument is of an unsigned type equivalent in size to a ptrdiff_t . The z modifier, when applied to a d or i conversion, indicates that the argument is of a signed type equivalent in size to a size_t . Similarly, when applied to an n conversion, it indicates that the argument is a pointer to a signed type equivalent in size to a size_t .

  The following length modifier is valid for the a, A, e, E, f, F, g, or G conversion:

  Modifier            a, A, e, E, f, F, g, G L          long double

  The following length modifier is valid for the c or s conversion:

  Modifier            c         s l (ell)            wint_t            wchar_t *

• A character that specifies the type of conversion to be applied.

A field width or precision, or both, may be indicated by an asterisk ‘*’ or an asterisk followed by one or more decimal digits and a ‘$’ instead of a digit string. In this case, an int argument supplies the field width or precision. A negative field width is treated as a left adjustment flag followed by a positive field width; a negative precision is treated as though it were missing. If a single format directive mixes positional (nn$) and non-positional arguments, the results are undefined.

The conversion specifiers and their meanings are:

The decimal point character is defined in the program’s locale (category LC_NUMERIC).

In no case does a non-existent or small field width cause truncation of a numeric field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result.

Examples

#include <stdio.h>
#include <wchar.h>
/* Illustrates how to use wprintf API */
int example_wprintf(void)
{
 int input = 12345;
 int rval;
 /* prints the integers on the standard output */
 rval = wprintf(L"%d", input);
 /* return the number of wide characters that were written */
 return(rval);
}

         

Output

12345

         

#include <stdio.h>
#include <wchar.h>
/* Illustrates how to use fwprintf API */
int example_fwprintf(void)
{
 FILE *fp = NULL;
 int retval;
 wchar_t *wcs = L"abc";
 /* open the file for writing*/
 fp = fopen("write.txt","w");
 if(fp == NULL)
 {
  wprintf(L"Error: File open\n");
  return (-1);
 }
 /* print the characters into the file */
 retval = fwprintf(fp, L"%s", wcs);
 /* Close the file opened for writing */
 fclose(fp);
 /* return the number of wide characters that were written */
 return (retval);
}

         

#include <stdio.h>
#include <wchar.h>
/* Illustrates how to use swprintf API */
int example_swprintf(wchar_t *buf, int maxlen)
{
 wchar_t *wcs = L"abcdef";
 int rval;
 /* prints the wide char string into the buffer buf */
 rval = swprintf(buf, maxlen, L"%s", wcs);
 /* return the number of wide characters that were written */
 return(rval);
}

         

#include <stdio.h>
#include <wchar.h>
/* Illustrates how to use vwprintf API */
int example_vwprintf(va_list input)
{
 int rval;
 /* prints the integers on the standard output */
 rval = vwprintf(L"%d", input);
 /* return the number of wide characters that were written */
 return(rval);
}

         

#include <stdio.h>
#include <wchar.h>
/* Illustrates how to use vfwprintf API */
int example_vfwprintf(va_list input)
{
  FILE *fp = NULL;
  int retval;
 
  /* open the file for writing*/
  fp = fopen("write.txt","w");
  if(fp == NULL)
  {
    wprintf(L"Error: File open\n");
    return (-1);
  }
  /* print the characters into the file */
  retval = vfwprintf(fp, L"%s", input);
  /* Close the file opened for writing */
  fclose(fp);
  /* return the number of wide characters that were written */
  return (retval);
}

         

#include <stdio.h>
#include <wchar.h>
/* Illustrates how to use vswprintf API */
int example_vswprintf(wchar_t *buf, int maxlen, va_list input)
{
 int rval;
 /* prints the wide char string into the buffer buf */
 rval = vswprintf(buf, maxlen, L"%s", input);
 /* return the number of wide characters that were written */
 return(rval);
}

         

Security considerations

Limitations

See also

Feedback