C Library Function - sprintf()
C Standard Library - <stdio.h>
Description
The C library function int sprintf(char *str, const char *format, ...) sends formatted output to a string pointed to by str.
Declaration
Here is the declaration for the sprintf() function.
int sprintf(char *str, const char *format, ...)
Parameters
str -- This is the pointer to an array of char elements where the resulting C string is stored.
format -- This is the string that contains the text to be written to the string. It can contain embedded format tags that are replaced by values specified in subsequent additional arguments and formatted as requested. The format tags prototype is %[flags][width][.precision][length]specifier, detailed as follows:
| Specifier | Output |
|---|---|
| c | Character |
| d or i | Signed decimal integer |
| e | Scientific notation (mantissa/exponent) using e character |
| E | Scientific notation (mantissa/exponent) using E character |
| f | Decimal floating point |
| g | Uses the shorter of %e or %f |
| G | Uses the shorter of %E or %f |
| o | Signed octal |
| s | String of characters |
| u | Unsigned decimal integer |
| x | Unsigned hexadecimal integer |
| X | Unsigned hexadecimal integer (uppercase) |
| p | Pointer address |
| n | Nothing printed |
| % | Character |
| Flags | Description |
|---|---|
| - | Left-justify within the given field width; right justification is the default (see width sub-specifier). |
| + | Forces to precede the result with a plus or minus sign (+ or -) even for positive numbers. By default, only negative numbers are preceded by a - sign. |
| (space) | If no sign is going to be written, a blank space is inserted before the value. |
| # | Used with o, x or X specifiers the value is preceded with 0, 0x or 0X respectively for values different than zero. <br>Used with e, E and f, it forces the written output to contain a decimal point even if no digits would follow. By default, if no digits follow, no decimal point is written. <br>Used with g or G, the result is the same as with e or E, but trailing zeros are not removed. |
| 0 | Left-pads the number with zeroes (0) instead of spaces, where padding is specified (see width sub-specifier). |
| Width | Description |
|---|---|
| (number) | Minimum number of characters to be printed. If the value to be printed is shorter than this number, the result is padded with blank spaces. The value is not truncated even if the result is larger. |
| * | The width is not specified in the format string, but as an additional integer value argument preceding the argument that has to be formatted. |
| .Precision | Description |
|---|---|
| .number | For integer specifiers (d, i, o, u, x, X): precision specifies the minimum number of digits to be written. If the value to be written is shorter than this number, the result is padded with leading zeros. The value is not truncated even if the result is longer. A precision of 0 means that no character is written for the value 0. <br>For e, E and f specifiers: this is the number of digits to be printed after the decimal point. <br>For g and G specifiers: This is the maximum number of significant digits to be printed. <br>For s: this is the maximum number of characters to be printed. By default all characters are printed until the ending null character is encountered. <br>For c type: it has no effect. <br>When no precision is specified, the default is 1. If the period is specified without an explicit value for precision, 0 is assumed. |
| .* | The precision is not specified in the format string, but as an additional integer value argument preceding the argument that has to be formatted. |
| Length | Description |
|---|---|
| h | The argument is interpreted as a short int or unsigned short int (only applies to integer specifiers: i, d, o, u, x and X). |
| l | The argument is interpreted as a long int or unsigned long int for integer specifiers (i, d, o, u, x and X), and as a wide character or wide character string for specifiers c and s. |
| L | The argument is interpreted as a long double (only applies to floating-point specifiers: e, E, f, g and G). |
- Additional arguments -- Depending on the format string, the function may expect a sequence of additional arguments, each containing a value to be inserted instead of each %-tag specified in the format parameter, if any. There should be the same number of these arguments as the number of %-tags that expect a value.
Return Value
Upon successful return, the function returns the total number of characters written, not including the terminating null character appended to the string. If failure occurs, a negative number is returned.
Example
The following example demonstrates the usage of the sprintf() function.
#include <stdio.h>
#include <math.h>
int main()
{
char str[80];
sprintf(str, "Value of Pi = %f", M_PI);
puts(str);
return(0);
}
Let's compile and run the above program, which will produce the following result:
Value of Pi = 3.141593