std::localtime

From cppreference.com
< cpp‎ | chrono‎ | c
C++
Date and time library
Time point
(C++11)
(C++20)
Duration
(C++11)
Clocks
(C++11)
(C++11)
(C++20)
(C++20)
(C++20)
(C++11)
(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)
(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.

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

Notes

This function may not be thread-safe.

POSIX requires that this function sets errno to EOVERFLOW

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
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/chrono/c/localtime&oldid=158578