Difference between revisions of "cpp/chrono/c/localtime"
From cppreference.com
m (→See also: relocated "C" localtime_r/localtime_s names to the proper place. Maybe it is worth mentioning them in such form as they do not have exact match in C++ thus far.) |
Andreas Krug (Talk | contribs) m (fmt, headers sorted) |
||
| Line 1: | Line 1: | ||
| − | {{cpp/title| localtime}} | + | {{cpp/title|localtime}} |
{{cpp/chrono/c/navbar}} | {{cpp/chrono/c/navbar}} | ||
| − | {{ddcl | header=ctime | | + | {{ddcl|header=ctime| |
std::tm* localtime( const std::time_t *time ); | std::tm* localtime( const std::time_t *time ); | ||
}} | }} | ||
| Line 9: | Line 9: | ||
===Parameters=== | ===Parameters=== | ||
{{par begin}} | {{par begin}} | ||
| − | {{par | time | pointer to a {{lc|std::time_t}} object to convert}} | + | {{par|time|pointer to a {{lc|std::time_t}} object to convert}} |
{{par end}} | {{par end}} | ||
===Return value=== | ===Return value=== | ||
| − | + | Pointer to a static internal {{lc|std::tm}} object on success, or null pointer otherwise. The structure may be shared between {{lc|std::gmtime}}, {{lc|std::localtime}}, and {{lc|std::ctime}}, and may be overwritten on each invocation. | |
| − | + | ||
===Notes=== | ===Notes=== | ||
| Line 25: | Line 24: | ||
===Example=== | ===Example=== | ||
{{example | {{example | ||
| − | + | |code= | |
| − | + | #include <ctime> | |
| + | #include <iomanip> | ||
#include <iostream> | #include <iostream> | ||
#include <sstream> | #include <sstream> | ||
| − | |||
| − | |||
int main() | int main() | ||
| Line 36: | Line 34: | ||
setenv("TZ", "/usr/share/zoneinfo/America/Los_Angeles", 1); // POSIX-specific | setenv("TZ", "/usr/share/zoneinfo/America/Los_Angeles", 1); // POSIX-specific | ||
| − | std::tm tm{}; | + | std::tm tm{}; // Zero initialise |
| − | tm.tm_year = 2020-1900; // 2020 | + | tm.tm_year = 2020 - 1900; // 2020 |
| − | tm.tm_mon = 2-1; // February | + | tm.tm_mon = 2 - 1; // February |
tm.tm_mday = 15; // 15th | tm.tm_mday = 15; // 15th | ||
tm.tm_hour = 10; | tm.tm_hour = 10; | ||
| Line 48: | Line 46: | ||
std::cout << "local: " << std::put_time(std::localtime(&t), "%c %Z") << '\n'; | std::cout << "local: " << std::put_time(std::localtime(&t), "%c %Z") << '\n'; | ||
} | } | ||
| − | + | |p=true | |
| − | + | |output= | |
UTC: Sat Feb 15 18:15:00 2020 GMT | UTC: Sat Feb 15 18:15:00 2020 GMT | ||
local: Sat Feb 15 10:15:00 2020 PST | local: Sat Feb 15 10:15:00 2020 PST | ||
| Line 56: | Line 54: | ||
===See also=== | ===See also=== | ||
{{dsc begin}} | {{dsc begin}} | ||
| − | {{dsc inc | cpp/chrono/c/dsc gmtime}} | + | {{dsc inc|cpp/chrono/c/dsc gmtime}} |
| − | {{dsc inc | c/chrono/dsc localtime}} | + | {{dsc inc|c/chrono/dsc localtime}} |
| − | {{dsc see c | c/chrono/localtime}} | + | {{dsc see c|c/chrono/localtime}} |
{{dsc end}} | {{dsc end}} | ||
{{langlinks|de|es|fr|it|ja|pt|ru|zh}} | {{langlinks|de|es|fr|it|ja|pt|ru|zh}} | ||
Revision as of 22:32, 19 August 2023
| Defined in header <ctime>
|
||
| std::tm* localtime( const std::time_t *time ); |
||
Converts given time since epoch as std::time_t value into calendar time, expressed in local time.
Contents |
Parameters
| time | - | pointer to a std::time_t object to convert |
Return value
Pointer to a static internal std::tm object on success, or null pointer otherwise. The structure may be shared between std::gmtime, std::localtime, and std::ctime, and may be overwritten on each invocation.
Notes
This function may not be thread-safe.
POSIX requires that this function sets errno to EOVERFLOW if it fails because the argument is too large.
POSIX specifies that the timezone information is determined by this function as if by calling tzset, which reads the environment variable TZ.
Example
Run this code
#include <ctime> #include <iomanip> #include <iostream> #include <sstream> int main() { setenv("TZ", "/usr/share/zoneinfo/America/Los_Angeles", 1); // POSIX-specific std::tm tm{}; // Zero initialise tm.tm_year = 2020 - 1900; // 2020 tm.tm_mon = 2 - 1; // February tm.tm_mday = 15; // 15th tm.tm_hour = 10; tm.tm_min = 15; tm.tm_isdst = 0; // Not daylight saving std::time_t t = std::mktime(&tm); std::cout << "UTC: " << std::put_time(std::gmtime(&t), "%c %Z") << '\n'; std::cout << "local: " << std::put_time(std::localtime(&t), "%c %Z") << '\n'; }
Possible output:
UTC: Sat Feb 15 18:15:00 2020 GMT local: Sat Feb 15 10:15:00 2020 PST
See also
| converts time since epoch to calendar time expressed as Universal Coordinated Time (function) | |
| (C23)(C11) |
converts time since epoch to calendar time expressed as local time (function) |
| C documentation for localtime
| |
