std::strftime (3) - Linux Man Pages

std::strftime: std::strftime

NAME

std::strftime - std::strftime

Synopsis


Defined in header <ctime>
std::size_t strftime( char* str, std::size_t count, const char* format, const std::tm* time );


Converts the date and time information from a given calendar time time to a null-terminated multibyte character string str according to format string format. Up to count bytes are written.

Parameters


str - pointer to the first element of the char array for output
count - maximum number of bytes to write
         pointer to a null-terminated multibyte character string specifying the format of conversion.
         The format string consists of zero or more conversion specifiers and ordinary characters (except %). All ordinary characters, including the terminating null character, are copied to the output string without modification. Each conversion specification begins with % character, optionally followed by E or O modifier (ignored if unsupported by the locale), followed by the character that determines the behavior of the specifier. The following format specifiers are available:


         Conversion Explanation Used fields
         specifier
         % writes literal %. The full conversion specification must be %%.
         n writes newline character
         (C++11)
         t writes horizontal tab character
         (C++11)
         Year
         Y writes year as a decimal number, e.g. 2017 tm_year
         EY writes year in the alternative representation, e.g.平成23年 (year Heisei 23) instead of 2011年 (year 2011) in ja_JP loctm_year
         (C++11)
         y writes last 2 digits of year as a decimal number (range [00,99]) tm_year
         Oy writes last 2 digits of year using the alternative numeric system, e.g. 十一 instead of 11 in ja_JP locale tm_year
         (C++11)
         Ey writes year as offset from locale's alternative calendar period %EC (locale-dependent) tm_year
         (C++11)
         C writes first 2 digits of year as a decimal number (range [00,99]) tm_year
         (C++11)
         EC writes name of the base year (period) in the locale's alternative representation, e.g. 平成 (Heisei era) in ja_JP tm_year
         (C++11)
                    writes ISO 8601 week-based year, i.e. the year that contains the specified week.
                    In IS0 8601 weeks begin with Monday and the first week of the year must satisfy the following requirements:
         G tm_year, tm_wday, tm_yday
         (C++11) * Includes January 4
                    * Includes first Thursday of the year


                    writes last 2 digits of ISO 8601 week-based year, i.e. the year that contains the specified week (range [00,99]).
                    In IS0 8601 weeks begin with Monday and the first week of the year must satisfy the following requirements:
         g tm_year, tm_wday, tm_yday
         (C++11) * Includes January 4
                    * Includes first Thursday of the year


         Month
         b writes abbreviated month name, e.g. Oct (locale dependent) tm_mon
         h synonym of b tm_mon
         (C++11)
         B writes full month name, e.g. October (locale dependent) tm_mon
         m writes month as a decimal number (range [01,12]) tm_mon
         Om writes month using the alternative numeric system, e.g. 十二 instead of 12 in ja_JP locale tm_mon
         (C++11)
         Week
         U writes week of the year as a decimal number (Sunday is the first day of the week) (range [00,53]) tm_year, tm_wday, tm_yday
         OU writes week of the year, as by %U, using the alternative numeric system, e.g. 五十二 instead of 52 in ja_JP locale tm_year, tm_wday, tm_yday
         (C++11)
         W writes week of the year as a decimal number (Monday is the first day of the week) (range [00,53]) tm_year, tm_wday, tm_yday
         OW writes week of the year, as by %W, using the alternative numeric system, e.g. 五十二 instead of 52 in ja_JP locale tm_year, tm_wday, tm_yday
         (C++11)
                    writes ISO 8601 week of the year (range [01,53]).
                    In IS0 8601 weeks begin with Monday and the first week of the year must satisfy the following requirements:
         V tm_year, tm_wday, tm_yday
         (C++11) * Includes January 4
                    * Includes first Thursday of the year


         OV writes week of the year, as by %V, using the alternative numeric system, e.g. 五十二 instead of 52 in ja_JP locale tm_year, tm_wday, tm_yday
format - (C++11)
         Day of the year/month
         j writes day of the year as a decimal number (range [001,366]) tm_yday
         d writes day of the month as a decimal number (range [01,31]) tm_mday
         Od writes zero-based day of the month using the alternative numeric system, e.g 二十七 instead of 27 in ja_JP locale tm_mday
         (C++11) Single character is preceded by a space.
         e writes day of the month as a decimal number (range [1,31]). tm_mday
         (C++11) Single digit is preceded by a space.
         Oe writes one-based day of the month using the alternative numeric system, e.g. 二十七 instead of 27 in ja_JP locale tm_mday
         (C++11) Single character is preceded by a space.
         Day of the week
         a writes abbreviated weekday name, e.g. Fri (locale dependent) tm_wday
         A writes full weekday name, e.g. Friday (locale dependent) tm_wday
         w writes weekday as a decimal number, where Sunday is 0 (range [0-6]) tm_wday
         Ow writes weekday, where Sunday is 0, using the alternative numeric system, e.g. 二 instead of 2 in ja_JP locale tm_wday
         (C++11)
         u writes weekday as a decimal number, where Monday is 1 (ISO 8601 format) (range [1-7]) tm_wday
         (C++11)
         Ou writes weekday, where Monday is 1, using the alternative numeric system, e.g. 二 instead of 2 in ja_JP locale tm_wday
         (C++11)
         Hour, minute, second
         H writes hour as a decimal number, 24 hour clock (range [00-23]) tm_hour
         OH writes hour from 24-hour clock using the alternative numeric system, e.g. 十八 instead of 18 in ja_JP locale tm_hour
         (C++11)
         I writes hour as a decimal number, 12 hour clock (range [01,12]) tm_hour
         OI writes hour from 12-hour clock using the alternative numeric system, e.g. 六 instead of 06 in ja_JP locale tm_hour
         (C++11)
         M writes minute as a decimal number (range [00,59]) tm_min
         OM writes minute using the alternative numeric system, e.g. 二十五 instead of 25 in ja_JP locale tm_min
         (C++11)
         S writes second as a decimal number (range [00,60]) tm_sec
         OS writes second using the alternative numeric system, e.g. 二十四 instead of 24 in ja_JP locale tm_sec
         (C++11)

Other


         c writes standard date and time string, e.g. Sun Oct 17 04:41:13 2010 (locale dependent) all
         Ec writes alternative date and time string, e.g. using 平成23年 (year Heisei 23) instead of 2011年 (year 2011) in ja_JP loalle
         (C++11)
         x writes localized date representation (locale dependent) all
         Ex writes alternative date representation, e.g. using 平成23年 (year Heisei 23) instead of 2011年 (year 2011) in ja_JP locall
         (C++11)
         X writes localized time representation (locale dependent) all
         EX writes alternative time representation (locale dependent) all
         (C++11)
         D equivalent to "%m/%d/%y" tm_mon, tm_mday, tm_year
         (C++11)
         F equivalent to "%Y-%m-%d" (the ISO 8601 date format) tm_mon, tm_mday, tm_year
         (C++11)
         r writes localized 12-hour clock time (locale dependent) tm_hour, tm_min, tm_sec
         (C++11)
         R equivalent to "%H:%M" tm_hour, tm_min
         (C++11)
         T equivalent to "%H:%M:%S" (the ISO 8601 time format) tm_hour, tm_min, tm_sec
         (C++11)
         p writes localized a.m. or p.m. (locale dependent) tm_hour
         z writes offset from UTC in the ISO 8601 format (e.g. -0430), or no characters if the time zone information is not available tm_isdst
         (C++11)
         Z writes locale-dependent time zone name or abbreviation, or no characters if the time zone information is not available tm_isdst


time - pointer to the date and time information to be converted

Return value


The number of bytes written into the character array pointed to by str not including the terminating '\0' on success. If count was reached before the entire string could be stored, 0 is returned and the contents are undefined.

Example


// Run this code


  #include <ctime>
  #include <iostream>
  #include <locale>


  int main()
  {
      std::locale::global(std::locale("ja_JP.utf8"));
      std::time_t t = std::time(nullptr);
      char mbstr[100];
      if (std::strftime(mbstr, sizeof(mbstr), "%A %c", std::localtime(&t))) {
          std::cout << mbstr << '\n';
      }
  }

Output:


  火曜日 2011年12月27日 17時39分03秒

See also


         converts a tm object to a textual representation
asctime (function)
         converts a time_t object to a textual representation
ctime (function)
         converts a tm object to custom wide string textual representation
wcsftime (function)


put_time formats and outputs a date/time value according to the specified format
         (function template)
(C++11)