localtime_r(), localtime64_r() — Convert time value to broken-down local time
Standards
Standards / Extensions | C or C++ | Dependencies |
---|---|---|
Single UNIX Specification, Version 2 |
both | OS/390 V2R8 |
Format
#define _XOPEN_SOURCE 500
#include <time.h>
struct tm *localtime_r(const time_t *__restrict__ clock,
struct tm *__restrict__ result);
#define _LARGE_TIME_API
#include <time.h>
struct tm *localtime64_r(const time64_t *__restrict__ clock,
struct tm *__restrict__ result);
General description
The localtime_r() function converts the calendar time pointed to by clock into a broken-down time stored in the structure to which result points. The localtime_r() function also returns a pointer to that same structure.
Unlike localtime(), the reentrant version is not required to set tzname.
The localtime64_r() function behaves exactly like localtime_r() except it will break down a time64_t value pointing to a calendar time beyond 03:14:07 UTC on January 19, 2038 with a limit of 23:59:59 UTC on December 31, 9999.
Returned value
If successful, localtime_r() returns a pointer to the structure pointed to by the argument result.
If an error is detected, localtime() returns a null pointer and set errno to indicate the error.
- Error Code
- Description
- EOVERFLOW
- The result cannot be represented.
Related information
- See the topic about internationalization of locales and character sets in z/OS XL C/C++ Programming Guide
- locale.h
- time.h
- asctime(), asctime64() — Convert time to character string
- asctime_r(), asctime64_r() — Convert date and time to a character string
- ctime(), ctime64() — Convert time to character string
- ctime_r(), ctime64_r() — Convert time value to date and time character string
- gmtime(), gmtime64() — Convert time to broken-down UTC time
- gmtime_r(), gmtime64_r() — Convert a time value to broken-down UTC time
- localdtconv() — Date and time formatting convention inquiry
- localtime(), localtime64() — Convert time and correct for local time
- mktime(), mktime64() — Convert local time
- strftime() — Convert to formatted time
- time(),time64() — Determine current UTC time
- tzset() — Set the time zone