C++ <ctime> - strftime() Function
The C++ <ctime> strftime() function converts the date and time information described in timeptr to a null-terminated multibyte character string str according to format string format, with a limit of maxsize characters.
Syntax
size_t strftime (char* str, size_t maxsize, const char* format, const struct tm* timeptr );
Parameters
str |
Specify pointer to the first element of the char array for output. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxsize |
Specify maximum number of characters to write to str, including the terminating null-character. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
format |
Specify pointer to a null-terminated multibyte character string (C string) specifying the format of conversion. The format string consists of zero or more format specifiers (sub-sequences beginning with %), and ordinary characters. All ordinary characters are copied to the output string without modification. The format specifiers are listed below:
Note: * The specifiers marked with an asterisk (*) are locale-dependent. Two locale-specific modifiers can also be inserted between the percentage sign (%) and the character that determines the behavior of the specifier. These modifiers are ignored if unsupported by the locale.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
timeptr |
Specify pointer to a tm structure that contains the date and time information to be converted. |
Return Value
Returns the total number of characters copied to str (not including the terminating null-character) on success. If maxsize is reached before the entire string could be stored, 0 is returned and the contents of the array pointed by str are undefined.
Example:
The example below shows the usage of strftime() function.
#include <iostream> #include <ctime> using namespace std; int main () { time_t rawtime; struct tm * timeinfo; char buffer[80]; time(&rawtime); timeinfo = localtime (&rawtime); strftime (buffer,80,"Current Date: %A, %F %I:%M %p", timeinfo); cout<<buffer; return 0; }
The output of the above code will be similar to:
Current Date: Wednesday, 2022-02-02 08:08 AM
❮ C++ <ctime> Library