man-pages/man3/timegm.3.html
2021-03-31 01:06:50 +01:00

166 lines
4.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of TIMEGM</TITLE>
</HEAD><BODY>
<H1>TIMEGM</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2016-12-12<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
timegm, timelocal - inverses of gmtime and localtime
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/time.h">time.h</A>&gt;</B>
<B>time_t timelocal(struct tm *</B><I>tm</I><B>);</B>
<B>time_t timegm(struct tm *</B><I>tm</I><B>);</B>
</PRE>
Feature Test Macro Requirements for glibc (see
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
<P>
<B>timelocal</B>(),
<B>timegm</B>():
<BR>&nbsp;&nbsp;&nbsp;&nbsp;Since&nbsp;glibc&nbsp;2.19:
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_DEFAULT_SOURCE
<BR>&nbsp;&nbsp;&nbsp;&nbsp;Glibc&nbsp;2.19&nbsp;and&nbsp;earlier:
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_BSD_SOURCE&nbsp;||&nbsp;_SVID_SOURCE
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The functions
<B>timelocal</B>()
and
<B>timegm</B>()
are the inverses of
<B><A HREF="/cgi-bin/man/man2html?3+localtime">localtime</A></B>(3)
and
<B><A HREF="/cgi-bin/man/man2html?3+gmtime">gmtime</A></B>(3).
Both functions take a broken-down time and convert it to calendar time
(seconds since the Epoch, 1970-01-01 00:00:00 +0000, UTC).
The difference between the two functions is that
<B>timelocal</B>()
takes the local timezone into account when doing the conversion, while
<B>timegm</B>()
takes the input value to be Coordinated Universal Time (UTC).
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success,
these functions return the calendar time (seconds since the Epoch),
expressed as a value of type
<I>time_t</I>.
On error, they return the value
<I>(time_t)&nbsp;-1</I>
and set
<I>errno</I>
to indicate the cause of the error.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<DL COMPACT>
<DT id="1"><B>EOVERFLOW</B>
<DD>
The result cannot be represented.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>timelocal</B>(),
<B>timegm</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe env locale<BR></TD></TR>
</TABLE>
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
These functions are nonstandard GNU extensions
that are also present on the BSDs.
Avoid their use.
<A NAME="lbAI">&nbsp;</A>
<H2>NOTES</H2>
The
<B>timelocal</B>()
function is equivalent to the POSIX standard function
<B><A HREF="/cgi-bin/man/man2html?3+mktime">mktime</A></B>(3).
There is no reason to ever use it.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+gmtime">gmtime</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+localtime">localtime</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+mktime">mktime</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+tzset">tzset</A></B>(3)
<A NAME="lbAK">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="2"><A HREF="#lbAB">NAME</A><DD>
<DT id="3"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="4"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="5"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="6"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="7"><A HREF="#lbAG">ATTRIBUTES</A><DD>
<DT id="8"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="9"><A HREF="#lbAI">NOTES</A><DD>
<DT id="10"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="11"><A HREF="#lbAK">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:58 GMT, March 31, 2021
</BODY>
</HTML>