Difference between revisions of "cpp/io/c/fprintf"
m (reorder seealso) |
Andreas Krug (Talk | contribs) m (fmt, @-@ -> @,@, .) |
||
(14 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
− | {{cpp/title | printf | fprintf | sprintf | snprintf}} | + | {{cpp/title|printf|fprintf|sprintf|snprintf}} |
{{cpp/io/c/navbar}} | {{cpp/io/c/navbar}} | ||
{{dcl begin}} | {{dcl begin}} | ||
− | {{dcl header | cstdio}} | + | {{dcl header|cstdio}} |
− | {{dcl | num=1 | | + | {{dcl|num=1| |
int printf( const char* format, ... ); | int printf( const char* format, ... ); | ||
}} | }} | ||
− | {{dcl | num=2 | | + | {{dcl|num=2| |
int fprintf( std::FILE* stream, const char* format, ... ); | int fprintf( std::FILE* stream, const char* format, ... ); | ||
}} | }} | ||
− | {{dcl | num=3 | | + | {{dcl|num=3| |
int sprintf( char* buffer, const char* format, ... ); | int sprintf( char* buffer, const char* format, ... ); | ||
}} | }} | ||
− | {{dcl | num=4 | since=c++11 | | + | {{dcl|num=4|since=c++11| |
int snprintf( char* buffer, std::size_t buf_size, const char* format, ... ); | int snprintf( char* buffer, std::size_t buf_size, const char* format, ... ); | ||
}} | }} | ||
Line 20: | Line 20: | ||
@1@ Writes the results to {{lc|stdout}}. | @1@ Writes the results to {{lc|stdout}}. | ||
− | @2@ Writes the results to a file stream {{ | + | @2@ Writes the results to a file stream {{c|stream}}. |
− | @3@ Writes the results to a character string {{ | + | @3@ Writes the results to a character string {{c|buffer}}. |
− | @4@ Writes the results to a character string {{ | + | @4@ Writes the results to a character string {{c|buffer}}. At most {{c|buf_size - 1}} characters are written. The resulting character string will be terminated with a null character, unless {{c|buf_size}} is zero. If {{c|buf_size}} is zero, nothing is written and {{c|buffer}} may be a null pointer, however the return value (number of bytes that would be written not including the null terminator) is still calculated and returned. |
− | If a call to {{tt|sprintf}} or {{tt|snprintf}} causes copying to take place between objects that overlap, the behavior is undefined. | + | If a call to {{tt|sprintf}} or {{tt|snprintf}} causes copying to take place between objects that overlap, the behavior is undefined (e.g. {{c|sprintf(buf, "%s text", buf);}}). |
===Parameters=== | ===Parameters=== | ||
{{par begin}} | {{par begin}} | ||
− | {{par | stream | output file stream to write to}} | + | {{par|stream|output file stream to write to}} |
− | {{par | buffer | pointer to a character string to write to}} | + | {{par|buffer|pointer to a character string to write to}} |
− | {{par | buf_size | up to buf_size - 1 characters may be written, plus the null terminator}} | + | {{par|buf_size|up to {{c|buf_size - 1}} characters may be written, plus the null terminator}} |
− | {{par | format | pointer to a null-terminated multibyte string specifying how to interpret the data | + | {{par|format|pointer to a null-terminated multibyte string specifying how to interpret the data}} |
− | + | {{par|...|arguments specifying data to print. If any argument after [[cpp/language/variadic_arguments#Default_conversions|default conversions]] is not the type expected by the corresponding conversion specifier, or if there are fewer arguments than required by {{c|format}}, the behavior is undefined. If there are more arguments than required by {{c|format}}, the extraneous arguments are evaluated and ignored}} | |
− | }} | + | |
− | {{par | ... | arguments specifying data to print. If any argument is not the type expected by the corresponding conversion specifier, or if there are fewer arguments than required by {{ | + | |
{{par end}} | {{par end}} | ||
+ | |||
+ | {{cpp/io/c/printf format}} | ||
===Return value=== | ===Return value=== | ||
− | @1 | + | @1,2@ Number of characters written if successful or a negative value if an error occurred. |
@3@ Number of characters written if successful (not including the terminating null character) or a negative value if an error occurred. | @3@ Number of characters written if successful (not including the terminating null character) or a negative value if an error occurred. | ||
− | @4@ Number of characters that would have been written for a sufficiently large buffer if successful (not including the terminating null character), or a negative value if an error occurred. Thus, the (null-terminated) output has been completely written if and only if the returned value is nonnegative and less than | + | @4@ Number of characters that would have been written for a sufficiently large buffer if successful (not including the terminating null character), or a negative value if an error occurred. Thus, the (null-terminated) output has been completely written if and only if the returned value is nonnegative and less than {{c|buf_size}}. |
===Notes=== | ===Notes=== | ||
{{cpp/io/c/printf posix note}} | {{cpp/io/c/printf posix note}} | ||
− | Calling {{tt|std::snprintf}} with zero {{ | + | Calling {{tt|std::snprintf}} with zero {{c|buf_size}} and null pointer for {{c|buffer}} is useful (when the overhead of double-call is acceptable) to determine the necessary buffer size to contain the output: |
{{source|1= | {{source|1= | ||
− | + | auto fmt = "sqrt(2) = %f"; | |
int sz = std::snprintf(nullptr, 0, fmt, std::sqrt(2)); | int sz = std::snprintf(nullptr, 0, fmt, std::sqrt(2)); | ||
std::vector<char> buf(sz + 1); // note +1 for null terminator | std::vector<char> buf(sz + 1); // note +1 for null terminator | ||
− | std:: | + | std::sprintf(buf.data(), fmt, std::sqrt(2)); // certain to fit |
}} | }} | ||
===Example=== | ===Example=== | ||
{{example | {{example | ||
− | + | |code= | |
+ | #include <cinttypes> | ||
+ | #include <cstdint> | ||
#include <cstdio> | #include <cstdio> | ||
#include <limits> | #include <limits> | ||
− | |||
− | |||
int main() | int main() | ||
{ | { | ||
− | |||
− | |||
const char* s = "Hello"; | const char* s = "Hello"; | ||
− | std::printf("\t[%10s]\n\t[%-10s]\n\t[%*s]\n\t[%-10.*s]\n\t[%-*.*s]\n" | + | std::printf("Strings:\n"); // same as std::puts("Strings:"); |
− | + | std::printf("\t[%10s]\n", s); | |
+ | std::printf("\t[%-10s]\n", s); | ||
+ | std::printf("\t[%*s]\n", 10, s); | ||
+ | std::printf("\t[%-10.*s]\n", 4, s); | ||
+ | std::printf("\t[%-*.*s]\n", 10, 4, s); | ||
− | std::printf("Characters:\t%c %%\n", | + | std::printf("Characters:\t%c %%\n", 'A'); |
− | std::printf("Integers\n"); | + | std::printf("Integers:\n"); |
− | std::printf(" | + | std::printf("\tDecimal: \t%i %d %.6i %i %.0i %+i %i\n", |
− | std::printf(" | + | 1, 2, 3, 0, 0, 4,-4); |
− | std::printf(" | + | std::printf("\tHexadecimal:\t%x %x %X %#x\n", |
+ | 5,10,10, 6); | ||
+ | std::printf("\tOctal: \t%o %#o %#o\n", | ||
+ | 10, 10, 4); | ||
− | std::printf("Floating point\n"); | + | std::printf("Floating point:\n"); |
− | std::printf(" | + | std::printf("\tRounding:\t%f %.0f %.32f\n", 1.5, 1.5, 1.3); |
− | std::printf(" | + | std::printf("\tPadding:\t%05.2f %.2f %5.2f\n", 1.5, 1.5, 1.5); |
− | std::printf(" | + | std::printf("\tScientific:\t%E %e\n", 1.5, 1.5); |
− | std::printf(" | + | std::printf("\tHexadecimal:\t%a %A\n", 1.5, 1.5); |
− | std::printf(" | + | std::printf("\tSpecial values:\t0/0=%g 1/0=%g\n", 0.0/0.0, 1.0/0.0); |
std::printf("Variable width control:\n"); | std::printf("Variable width control:\n"); | ||
− | std::printf(" | + | std::printf("\tright-justified variable width: '%*c'\n", 5, 'x'); |
− | int r = std::printf(" | + | int r = std::printf("\tleft-justified variable width : '%*c'\n", -5, 'x'); |
std::printf("(the last printf printed %d characters)\n", r); | std::printf("(the last printf printed %d characters)\n", r); | ||
− | + | std::printf("Fixed-width types:\n"); | |
std::uint32_t val = std::numeric_limits<std::uint32_t>::max(); | std::uint32_t val = std::numeric_limits<std::uint32_t>::max(); | ||
− | std::printf(" | + | std::printf("\tLargest 32-bit value is %" PRIu32 " or %#" PRIx32 "\n", |
+ | val, val); | ||
} | } | ||
− | + | |p=true | |
+ | |output= | ||
Strings: | Strings: | ||
− | + | [ Hello] | |
− | + | [Hello ] | |
− | + | [ Hello] | |
− | + | [Hell ] | |
− | + | [Hell ] | |
− | Characters: | + | Characters: A % |
− | Integers | + | Integers: |
− | Decimal: | + | Decimal: 1 2 000003 0 +4 -4 |
− | Hexadecimal: | + | Hexadecimal: 5 a A 0x6 |
− | Octal: | + | Octal: 12 012 04 |
− | Floating point | + | Floating point: |
− | Rounding: | + | Rounding: 1.500000 2 1.30000000000000004440892098500626 |
− | Padding: | + | Padding: 01.50 1.50 1.50 |
− | Scientific: | + | Scientific: 1.500000E+00 1.500000e+00 |
− | Hexadecimal: | + | Hexadecimal: 0x1.8p+0 0X1.8P+0 |
− | Special values: 0/0=nan 1/0=inf | + | Special values: 0/0=-nan 1/0=inf |
Variable width control: | Variable width control: | ||
− | right-justified variable width: ' x' | + | right-justified variable width: ' x' |
− | left-justified variable width : 'x ' | + | left-justified variable width : 'x ' |
− | (the last printf printed | + | (the last printf printed 41 characters) |
− | Largest 32-bit value is 4294967295 or 0xffffffff | + | Fixed-width types: |
+ | Largest 32-bit value is 4294967295 or 0xffffffff | ||
}} | }} | ||
===See also=== | ===See also=== | ||
{{dsc begin}} | {{dsc begin}} | ||
− | {{dsc inc | cpp/io/c/dsc fwprintf}} | + | {{dsc inc|cpp/io/c/dsc fwprintf}} |
− | {{dsc inc | cpp/io/c/dsc vfprintf}} | + | {{dsc inc|cpp/io/c/dsc vfprintf}} |
− | {{dsc inc | cpp/io/c/dsc fputs}} | + | {{dsc inc|cpp/io/c/dsc fputs}} |
− | {{dsc inc | cpp/io/c/dsc fscanf}} | + | {{dsc inc|cpp/io/c/dsc fscanf}} |
− | {{dsc inc | cpp/utility/dsc to_chars}} | + | {{dsc inc|cpp/utility/dsc to_chars}} |
− | {{dsc see c | c/io/fprintf | printf | fprintf | sprintf | snprintf}} | + | {{dsc inc|cpp/io/dsc print}} |
+ | {{dsc inc|cpp/io/dsc println}} | ||
+ | {{dsc see c|c/io/fprintf|printf|fprintf|sprintf|snprintf}} | ||
{{dsc end}} | {{dsc end}} | ||
− | + | {{langlinks|de|es|fr|it|ja|pt|ru|zh}} | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |
Latest revision as of 03:58, 10 September 2023
Defined in header <cstdio>
|
||
int printf( const char* format, ... ); |
(1) | |
int fprintf( std::FILE* stream, const char* format, ... ); |
(2) | |
int sprintf( char* buffer, const char* format, ... ); |
(3) | |
int snprintf( char* buffer, std::size_t buf_size, const char* format, ... ); |
(4) | (since C++11) |
Loads the data from the given locations, converts them to character string equivalents and writes the results to a variety of sinks.
If a call to sprintf
or snprintf
causes copying to take place between objects that overlap, the behavior is undefined (e.g. sprintf(buf, "%s text", buf);).
Contents |
[edit] Parameters
stream | - | output file stream to write to |
buffer | - | pointer to a character string to write to |
buf_size | - | up to buf_size - 1 characters may be written, plus the null terminator |
format | - | pointer to a null-terminated multibyte string specifying how to interpret the data |
... | - | arguments specifying data to print. If any argument after default conversions is not the type expected by the corresponding conversion specifier, or if there are fewer arguments than required by format, the behavior is undefined. If there are more arguments than required by format, the extraneous arguments are evaluated and ignored |
The format string consists of ordinary byte characters (except %
), which are copied unchanged into the output stream, and conversion specifications. Each conversion specification has the following format:
- introductory
%
character.
- introductory
- (optional) one or more flags that modify the behavior of the conversion:
-
-
: the result of the conversion is left-justified within the field (by default it is right-justified). -
+
: the sign of signed conversions is always prepended to the result of the conversion (by default the result is preceded by minus only when it is negative). - space: if the result of a signed conversion does not start with a sign character, or is empty, space is prepended to the result. It is ignored if
+
flag is present. -
#
: alternative form of the conversion is performed. See the table below for exact effects otherwise the behavior is undefined. -
0
: for integer and floating-point number conversions, leading zeros are used to pad the field instead of space characters. For integer numbers it is ignored if the precision is explicitly specified. For other conversions using this flag results in undefined behavior. It is ignored if-
flag is present.
-
- (optional) integer value or
*
that specifies minimum field width. The result is padded with space characters (by default), if required, on the left when right-justified, or on the right if left-justified. In the case when*
is used, the width is specified by an additional argument of type int, which appears before the argument to be converted and the argument supplying precision if one is supplied. If the value of the argument is negative, it results with the-
flag specified and positive field width (Note: This is the minimum width: The value is never truncated.).
- (optional) integer value or
- (optional)
.
followed by integer number or*
, or neither that specifies precision of the conversion. In the case when*
is used, the precision is specified by an additional argument of type int, which appears before the argument to be converted, but after the argument supplying minimum field width if one is supplied. If the value of this argument is negative, it is ignored. If neither a number nor*
is used, the precision is taken as zero. See the table below for exact effects of precision.
- (optional)
- (optional) length modifier that specifies the size of the argument (in combination with the conversion format specifier, it specifies the type of the corresponding argument).
- conversion format specifier.
The following format specifiers are available:
Conversion Specifier |
Explanation | Expected Argument Type | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
Length →
Modifier |
hh
(C++11) |
h
|
(none) | l
|
ll
(C++11) |
j
(C++11) |
z
(C++11) |
t
(C++11) |
L
| |
%
|
Writes literal % . The full conversion specification must be %% .
|
N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
c
|
The argument is first converted to unsigned char. If the l modifier is used, the argument is first converted to a character string as if by %ls with a wchar_t[2] argument. |
N/A | N/A | int |
wint_t |
N/A | N/A | N/A | N/A | N/A |
s
|
The argument must be a pointer to the initial element of an array of characters. Precision specifies the maximum number of bytes to be written. If Precision is not specified, writes every byte up to and not including the first null terminator. If the l specifier is used, the argument must be a pointer to the initial element of an array of wchar_t, which is converted to char array as if by a call to wcrtomb with zero-initialized conversion state. |
N/A | N/A | char* |
wchar_t* |
N/A | N/A | N/A | N/A | N/A |
d i
|
Precision specifies the minimum number of digits to appear. The default precision is 1. |
signed char |
short |
int |
long |
long long |
intmax_t |
signed size_t |
ptrdiff_t |
N/A |
o
|
Precision specifies the minimum number of digits to appear. The default precision is 1. If both the converted value and the precision are 0 the conversion results in no characters. In the alternative implementation precision is increased if necessary, to write one leading zero. In that case if both the converted value and the precision are 0, single 0 is written. |
unsigned char |
unsigned short |
unsigned int |
unsigned long |
unsigned long long |
uintmax_t |
size_t |
unsigned version of ptrdiff_t |
N/A |
x X
|
For the |
N/A | ||||||||
u
|
Precision specifies the minimum number of digits to appear. The default precision is 1. If both the converted value and the precision are 0 the conversion results in no characters. |
N/A | ||||||||
f F
|
Precision specifies the exact number of digits to appear after the decimal point character. The default precision is 6. In the alternative implementation decimal point character is written even if no digits follow it. For infinity and not-a-number conversion style see notes. |
N/A | N/A | double |
double(C++11) |
N/A | N/A | N/A | N/A | long double |
e E
|
For the |
N/A | N/A | N/A | N/A | N/A | N/A | |||
a A
(C++11) |
For the |
N/A | N/A | N/A | N/A | N/A | N/A | |||
g G
|
For the
Unless alternative representation is requested the trailing zeros are removed, also the decimal point character is removed if no fractional part is left. For infinity and not-a-number conversion style see notes. |
N/A | N/A | N/A | N/A | N/A | N/A | |||
n
|
The result is written to the value pointed to by the argument.
The specification may not contain any flag, field width, or precision. |
signed char* |
short* |
int* |
long* |
long long* |
intmax_t* |
signed size_t* |
ptrdiff_t* |
N/A |
p
|
Writes an implementation defined character sequence defining a pointer. | N/A | N/A | void* | N/A | N/A | N/A | N/A | N/A | N/A |
The floating-point conversion functions convert infinity to inf
or infinity
. Which one is used is implementation defined.
Not-a-number is converted to nan
or nan(char_sequence)
. Which one is used is implementation defined.
The conversions F
, E
, G
, A
output INF
, INFINITY
, NAN
instead.
Even though %c
expects int
argument, it is safe to pass a char
because of the integer promotion that takes place when a variadic function is called.
The correct conversion specifications for the fixed-width character types (int8_t, etc) are defined in the header <cinttypes> (although PRIdMAX, PRIuMAX, etc is synonymous with %jd
, %ju
, etc).
The memory-writing conversion specifier %n is a common target of security exploits where format strings depend on user input and is not supported by the bounds-checked printf_s
family of functions.
There is a sequence point after the action of each conversion specifier; this permits storing multiple %n results in the same variable or, as an edge case, printing a string modified by an earlier %n within the same call.
If a conversion specification is invalid, the behavior is undefined.
[edit] Return value
[edit] Notes
POSIX specifies that errno is set on error. It also specifies additional conversion specifications, most notably support for argument reordering (n$ immediately after % indicates n
th argument).
Calling std::snprintf
with zero buf_size and null pointer for buffer is useful (when the overhead of double-call is acceptable) to determine the necessary buffer size to contain the output:
auto fmt = "sqrt(2) = %f"; int sz = std::snprintf(nullptr, 0, fmt, std::sqrt(2)); std::vector<char> buf(sz + 1); // note +1 for null terminator std::sprintf(buf.data(), fmt, std::sqrt(2)); // certain to fit
[edit] Example
#include <cinttypes> #include <cstdint> #include <cstdio> #include <limits> int main() { const char* s = "Hello"; std::printf("Strings:\n"); // same as std::puts("Strings:"); std::printf("\t[%10s]\n", s); std::printf("\t[%-10s]\n", s); std::printf("\t[%*s]\n", 10, s); std::printf("\t[%-10.*s]\n", 4, s); std::printf("\t[%-*.*s]\n", 10, 4, s); std::printf("Characters:\t%c %%\n", 'A'); std::printf("Integers:\n"); std::printf("\tDecimal: \t%i %d %.6i %i %.0i %+i %i\n", 1, 2, 3, 0, 0, 4,-4); std::printf("\tHexadecimal:\t%x %x %X %#x\n", 5,10,10, 6); std::printf("\tOctal: \t%o %#o %#o\n", 10, 10, 4); std::printf("Floating point:\n"); std::printf("\tRounding:\t%f %.0f %.32f\n", 1.5, 1.5, 1.3); std::printf("\tPadding:\t%05.2f %.2f %5.2f\n", 1.5, 1.5, 1.5); std::printf("\tScientific:\t%E %e\n", 1.5, 1.5); std::printf("\tHexadecimal:\t%a %A\n", 1.5, 1.5); std::printf("\tSpecial values:\t0/0=%g 1/0=%g\n", 0.0/0.0, 1.0/0.0); std::printf("Variable width control:\n"); std::printf("\tright-justified variable width: '%*c'\n", 5, 'x'); int r = std::printf("\tleft-justified variable width : '%*c'\n", -5, 'x'); std::printf("(the last printf printed %d characters)\n", r); std::printf("Fixed-width types:\n"); std::uint32_t val = std::numeric_limits<std::uint32_t>::max(); std::printf("\tLargest 32-bit value is %" PRIu32 " or %#" PRIx32 "\n", val, val); }
Possible output:
Strings: [ Hello] [Hello ] [ Hello] [Hell ] [Hell ] Characters: A % Integers: Decimal: 1 2 000003 0 +4 -4 Hexadecimal: 5 a A 0x6 Octal: 12 012 04 Floating point: Rounding: 1.500000 2 1.30000000000000004440892098500626 Padding: 01.50 1.50 1.50 Scientific: 1.500000E+00 1.500000e+00 Hexadecimal: 0x1.8p+0 0X1.8P+0 Special values: 0/0=-nan 1/0=inf Variable width control: right-justified variable width: ' x' left-justified variable width : 'x ' (the last printf printed 41 characters) Fixed-width types: Largest 32-bit value is 4294967295 or 0xffffffff
[edit] See also
prints formatted wide character output to stdout, a file stream or a buffer (function) | |
prints formatted output to stdout, a file stream or a buffer using variable argument list (function) | |
writes a character string to a file stream (function) | |
reads formatted input from stdin, a file stream or a buffer (function) | |
(C++17) |
converts an integer or floating-point value to a character sequence (function) |
(C++23) |
prints to stdout or a file stream using formatted representation of the arguments (function template) |
(C++23) |
same as std::print except that each print is terminated by additional new line (function template) |
C documentation for printf, fprintf, sprintf, snprintf
|