localtime、localtime_r、localtime_s

 

C

编译器支持

语言

头文件

类型支持

程序实用工具

可变参数函数支持

错误处理

动态内存管理

字符串库

算法

数值

日期和时间实用工具

输入/输出支持

本地化支持

并发支持 (C11)

技术规范

符号索引

 

日期和时间实用工具

函数

时间操作

difftime

time

clock

timespec_get (C11)

timespec_getres (C23)

格式转换

asctimeasctime_s (C23 中已弃用)(C11)

ctimectime_s (C23 中已弃用)(C11)

strftime

wcsftime (C95)

gmtimegmtime_rgmtime_s (C23)(C11)

localtimelocaltime_rlocaltime_s (C23)(C11)

mktime

常量

CLOCKS_PER_SEC

类型

tm

time_t

clock_t

timespec (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) 将给定的纪元时间（time_t 值，由 timer 指向）转换为日历时间，以本地时间表示，以 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 对象的指针（如果成功），否则为 null 指针。该结构可能在 gmtime、localtime 和 ctime 之间共享，并且可能在每次调用时被覆盖。

2,3) buf 指针的副本，或 null 指针（如果发生错误，可能是运行时约束冲突或无法将指定时间转换为本地日历时间）。

备注

函数 localtime 可能不是线程安全的。

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 函数 (p: 343)

• C89/C90 标准 (ISO/IEC 9899:1990)

• 4.12.3.4 localtime 函数

另请参见

gmtimegmtime_rgmtime_s (C23)(C11)	将纪元时间转换为表示为协调世界时 (UTC) 的日历时间 (函数)
C++ 文档 for localtime