MKTIME(3POSIX)

πŸ’– MKTIME(3POSIX) β€” the POSIX Programmer's Manual, bestie edition πŸ’–

okay so real talk first: this page lives in the POSIX Programmer's Manual, and there's a whole PROLOG situation you need to know about before we go any further. The Linux implementation of this interface may differ (so like, go check the corresponding Linux manual page for the deets on Linux behavior), and honestly? the interface might not even be implemented on Linux at all. πŸ™ˆ forewarned is forearmed, babes.


✨ NAME ✨

mktime β€” convert broken-down time into time since the Epoch


🌸 SYNOPSIS 🌸

#include <time.h>

time_t mktime(struct tm *timeptr);

πŸ¦‹ DESCRIPTION πŸ¦‹

so the tea here is that everything on this reference page is aligned with the ISO C standard. If there's any conflict between what's written here and the ISO C standard, that conflict is unintentional β€” no drama intended, promise. This volume of POSIX.1‐2017 defers to the ISO C standard. periodt.

The mktime() function shall convert the broken-down time, expressed as local time, in the structure pointed to by timeptr, into a time since the Epoch value with the same encoding as that of the values returned by time(). πŸ•°οΈ

And here's the part that lowkey trips people up: the original values of the tm_wday and tm_yday components of the structure shall be ignored, and the original values of the other components shall not be restricted to the ranges described in <time.h>. yeah. you can hand it unhinged numbers. it's built different.

A positive or 0 value for tm_isdst shall cause mktime() to presume initially that Daylight Savings Time, respectively, is or is not in effect for the specified time. A negative value for tm_isdst shall cause mktime() to attempt to determine whether Daylight Savings Time is in effect for the specified time. she'll figure it out. 🧚

Local timezone information shall be set as though mktime() called tzset().

The relationship between the tm structure (defined in the <time.h> header) and the time in seconds since the Epoch is that the result shall be as specified in the expression given in the definition of seconds since the Epoch (see the Base Definitions volume of POSIX.1‐2017, Section 4.16, Seconds Since the Epoch) corrected for timezone and any seasonal time adjustments. The names other than tm_yday in the structure and in the expression correspond, and the tm_yday value used in the expression is the day of the year from 0 to 365 inclusive, calculated from the other tm structure members specified in <time.h> (excluding tm_wday). math girlies rise πŸ‘‘

Upon successful completion, the values of the tm_wday and tm_yday components of the structure shall be set appropriately, and the other components shall be set to represent the specified time since the Epoch β€” but with their values forced to the ranges indicated in the <time.h> entry. and the plot twist: the final value of tm_mday shall not be set until tm_mon and tm_year are determined. iconic sequencing honestly.


πŸ’… RETURN VALUE πŸ’…

The mktime() function shall return the specified time since the Epoch encoded as a value of type time_t. If the time since the Epoch cannot be represented, the function shall return the value (time_t)-1 and set errno to indicate the error. 😭


πŸ”₯ ERRORS πŸ”₯

The mktime() function shall fail if:

  • EOVERFLOW β€” The result cannot be represented.

The following sections are informative.


🌈 EXAMPLES 🌈

What day of the week is July 4, 2001? (a classic. a banger. we love a lil date math moment.)

#include <stdio.h>
#include <time.h>

struct tm time_str;

char daybuf[20];

int main(void)
{
    time_str.tm_year = 2001 β€” 1900;
    time_str.tm_mon = 7 β€” 1;
    time_str.tm_mday = 4;
    time_str.tm_hour = 0;
    time_str.tm_min = 0;
    time_str.tm_sec = 1;
    time_str.tm_isdst = -1;
    if (mktime(&time_str) == -1)
        (void)puts("-unknown-");
    else {
        (void)strftime(daybuf, sizeof(daybuf), "%A", &time_str);
        (void)puts(daybuf);
    }
    return 0;
}

πŸ“ APPLICATION USAGE πŸ“

None. (she said nothing. we stan a low-maintenance queen.)


⭐ RATIONALE ⭐

None.


πŸ’œ FUTURE DIRECTIONS πŸ’œ

None.


🫢 SEE ALSO 🫢

asctime(), clock(), ctime(), difftime(), gmtime(), localtime(), strftime(), strptime(), time(), tzset(), utime()

The Base Definitions volume of POSIX.1‐2017, Section 4.16, Seconds Since the Epoch, <time.h>


Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .


ok that's the whole page, no skips, no cuts, every flag and field accounted for. go forth and convert your broken-down time, bestie. πŸ•°οΈβœ¨

and that's a wrap on the 2017 edition, brought to you by IEEE/The Open Group β€” mwah, take care of her, she's MKTIME(3POSIX) and she's doing her best πŸ’–πŸŽ€