Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/chrono/c/localtime"

From cppreference.com
< cpp‎ | chrono‎ | c
m (Text replace - "{{example}}" to "===Example===")
m (→‎Synopsis: " *" → "* " (for consistency))
 
(28 intermediate revisions by 11 users not shown)
Line 1: Line 1:
−
{{cpp/title| localtime}}
+
{{cpp/title|localtime}}
−
{{cpp/chrono/c/sidebar}}
+
{{cpp/chrono/c/navbar}}
−
{{ddcl | header=ctime |
+
{{ddcl|header=ctime|
−
struct tm *localtime( const time_t *time );
+
std::tm* localtime( const std::time_t* time );
 
}}
 
}}
  
−
Converts given time since epoch as {{rlpt|time_t}} value into calendar time, expressed in local time.  
+
Converts given time since epoch as {{lc|std::time_t}} value into calendar time, expressed in local time.  
  
−
<!-- ======== -->
+
===Parameters===
−
{{params}}
+
{{par begin}}
−
{{param list begin}}
+
{{par|time|pointer to a {{lc|std::time_t}} object to convert}}
−
{{param list item | time | pointer to a time_t object to convert}}
+
{{par end}}
−
{{param list end}}
+
  
−
<!-- ======== -->
+
===Return value===
−
{{returns}}
+
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.
  
−
pointer to a static internal {{rlpt|tm}} object on success, or {{cpp|NULL}} otherwise. The structure is shared between {{rlpf|gmtime}} and {{rlpf|localtime}} and is overwritten on each invocation.
+
===Notes===
 +
This function may not be thread-safe.
 +
 
 +
POSIX requires that this function sets {{lc|errno}} to {{lc|EOVERFLOW}} if it fails because the argument is too large.
 +
 
 +
[https://pubs.opengroup.org/onlinepubs/9699919799/functions/localtime.html POSIX specifies] that the timezone information is determined by this function as if by calling [https://pubs.opengroup.org/onlinepubs/9699919799/functions/tzset.html {{tt|tzset}}], which reads the environment variable {{c|TZ}}.
  
−
<!-- ======== -->
 
 
===Example===
 
===Example===
−
{{example cpp
+
{{example
−
|
+
|code=
−
  | code=
+
#include <ctime>
−
  | output=
+
#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';
 +
}
 +
|p=true
 +
|output=
 +
UTC:  Sat Feb 15 18:15:00 2020 GMT
 +
local: Sat Feb 15 10:15:00 2020 PST
 
}}
 
}}
  
−
<!-- ======== -->
+
===See also===
−
{{see also}}
+
{{dsc begin}}
−
{{dcl list begin}}
+
{{dsc inc|cpp/chrono/c/dsc gmtime}}
−
{{dcl list template | cpp/chrono/c/dcl list gmtime}}
+
{{dsc inc|c/chrono/dsc localtime}}
−
{{dcl list end}}
+
{{dsc see c|c/chrono/localtime}}
 +
{{dsc end}}
 +
 
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 14:44, 9 September 2023

 
C++
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Date and time utilities
Time point
(C++11)
(C++20)
Duration
(C++11)
Clocks
(C++11)
(C++11)
(C++20)
(C++20)
(C++20)
(C++20)
Time of day
(C++20)(C++20)
(C++20)(C++20)
(C++20)

Calendar
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)(C++20)
Time zone
(C++20)
(C++20)
(C++20)(C++20)(C++20)(C++20)  
(C++20)
chrono I/O
(C++20)
C-style date and time
 
C-style date and time utilities
Functions
Time manipulation
(C++17)
Format conversions
localtime
Constants
Types
(C++17)
 
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

[edit] Parameters

time - pointer to a std::time_t object to convert

[edit] 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.

[edit] 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.

[edit] 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

[edit] See also

 converts time since epoch to calendar time expressed as Universal Coordinated Time
(function) [edit]
(C23)(C11)
 converts time since epoch to calendar time expressed as local time
(function) [edit]
C documentation for localtime
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/chrono/c/localtime&oldid=158578"