Namespaces
Variants

localtime, localtime_r, localtime_s

From cppreference.net
C
Date and time utilities
Functions
Time manipulation
(C11)
(C23)
Format conversions
(deprecated in C23) (C11)
(deprecated in C23) (C11)
(C95)
(C23) (C11)
localtime localtime_r localtime_s
(C23) (C11)
Constants
Types
(C11)
定义于头文件 <time.h>
struct tm * localtime ( const time_t * timer ) ;
(1)
struct tm * localtime_r ( const time_t * timer, struct tm * buf ) ;
(2) (C23 起)
struct tm * localtime_s ( const time_t * restrict timer, struct tm * restrict buf ) ;
(3) (C11 起)
1) 将给定的纪元时间（由 timer 指向的 time_t 值）转换为本地时间表示的日历时间，格式为 struct tm 。结果存储在静态存储区中，并返回指向该静态存储区的指针。
2) 与 (1) 相同，区别在于该函数使用用户提供的存储空间 buf 来存储结果。
3) 与 (1) 相同，区别在于该函数使用用户提供的存储空间 buf 存放结果，且会在运行时检测以下错误并调用当前安装的 约束处理函数 ：
  • timer 或 buf 是空指针
与所有边界检查函数一样，仅当实现定义了 __STDC_LIB_EXT1__ 且用户在包含 <time.h> 之前将 __STDC_WANT_LIB_EXT1__ 定义为整型常量 1 时，才保证 localtime_s 可用。

目录

参数

timer - 指向要转换的 time_t 对象的指针
buf - 指向用于存储结果的 struct tm 对象的指针

返回值

1) 成功时返回指向静态内部 tm 对象的指针，否则返回空指针。该结构体可能被 gmtime 、 localtime 和 ctime 共享，且每次调用都可能被覆盖。
2,3) buf 指针的副本，或在错误时返回空指针（可能是运行时约束违规或无法将指定时间转换为本地日历时间）。

注释

函数 localtime 可能不具备线程安全性。 Microsoft CRT 的实现是线程安全的。

POSIX要求当 localtime 和 localtime_r 因参数过大而失败时，必须将 errno 设置为 EOVERFLOW 。

POSIX规范 规定，时区信息由 localtime 和 localtime_r 函数确定，其确定方式如同调用了 tzset 函数，该函数会读取环境变量 TZ 。

Microsoft CRT 中 localtime_s 的实现与 C 标准不兼容，因其参数顺序相反且返回 errno_t 类型。

示例

运行此代码 
#define __STDC_WANT_LIB_EXT1__ 1
#define _XOPEN_SOURCE // for putenv
#include <stdio.h>
#include <stdlib.h>   // for putenv
#include <time.h>
int main(void)
{
    time_t t = time(NULL);
    printf("UTC:       %s", asctime(gmtime(&t)));
    printf("local:     %s", asctime(localtime(&t)));
    // POSIX-specific
    putenv("TZ=Asia/Singapore");
    printf("Singapore: %s", asctime(localtime(&t)));
#ifdef __STDC_LIB_EXT1__
    struct tm buf;
    char str[26];
    asctime_s(str, sizeof str, gmtime_s(&t, &buf));
    printf("UTC:       %s", str);
    asctime_s(str, sizeof str, localtime_s(&t, &buf));
    printf("local:     %s", str);
#endif
}

可能的输出： 

UTC:       Fri Sep 15 14:22:05 2017
local:     Fri Sep 15 14:22:05 2017
Singapore: Fri Sep 15 22:22:05 2017
UTC:       Fri Sep 15 14:22:05 2017
local:     Fri Sep 15 14:22:05 2017

参考文献

  • C23 标准 (ISO/IEC 9899:2024):
  • 7.27.3.4 localtime 函数 (p: TBD)
  • K.3.8.2.4 localtime_s 函数 (p: TBD)
  • C17 标准 (ISO/IEC 9899:2018):
  • 7.27.3.4 localtime 函数 (p: 288)
  • K.3.8.2.4 localtime_s 函数 (p: 455)
  • C11 标准 (ISO/IEC 9899:2011):
  • 7.27.3.4 localtime 函数 (p: 394)
  • K.3.8.2.4 localtime_s 函数 (p: 627)
  • C99标准（ISO/IEC 9899:1999）：
  • 7.23.3.4 localtime函数（页码：343）
  • C89/C90 标准 (ISO/IEC 9899:1990):
  • 4.12.3.4 localtime 函数

参见

(C23) (C11)
将自纪元起的时间转换为协调世界时（UTC）表示的日历时间
(函数)
C++ 文档 关于 localtime