ctime(3)

NOM
asctime, ctime, gmtime, localtime, mktime, asctime_r, ctime_r, gmtime_r, localtime_r — Convertir des dates et des temps au format année/mois/jour ou au format ASCII

BIBLIOTHÈQUE
Bibliothèque C standard (libc, -lc)

SYNOPSIS
#include <time.h>

char *asctime(const struct tm *tm);
char *asctime_r(const struct tm *restrict tm,
                    char tampon[restrict 26]);

char *ctime(const time_t *timep);
char *ctime_r(const time_t *restrict timep,
                    char tampon[restrict 26]);

struct tm *gmtime(const time_t *timep);
struct tm *gmtime_r(const time_t *restrict timep,
                    struct tm *restrict résultat);

struct tm *localtime(const time_t *timep);
struct tm *localtime_r(const time_t *restrict timep,
                    struct tm *restrict résultat);

time_t mktime(struct tm *tm);

    Exigences de macros de test de fonctionnalités pour la glibc (consulter feature_test_macros(7)) :

asctime_r(), ctime_r(), gmtime_r(), localtime_r() :
    _POSIX_C_SOURCE
        || /* glibc <= 2.19 : */ _BSD_SOURCE || _SVID_SOURCE

DESCRIPTION
Les fonctions ctime(), gmtime() et localtime() prennent toutes un paramètre de type time_t qui représente un temps en secondes. Si l'on interprète ce paramètre comme une valeur de temps absolue, il s'agit du nombre de secondes écoulées depuis l'Époque POSIX, 1er janvier 1970 à 00:00:00 (UTC).

Les fonctions asctime() et mktime() utilisent toutes deux un paramètre représentant le temps dans un format humain, c'est-à-dire année, mois, jour, etc.

La représentation humaine (« broken-down time ») est stockée dans la structure tm décrite dans tm(3type).

L'appel ctime(t) est équivalent à asctime(localtime(t)). Il convertit le temps calendaire t en une chaîne de caractères, terminée par un octet NULL de la forme

    « Wed Jun 30 21:49:08 1993\n »

Les abréviations des jours de la semaine sont « Sun », « Mon », « Tue », « Wed », « Thu », « Fri » et « Sat ». Les abréviations des mois sont « Jan », « Feb », « Mar », « Apr », « May », « Jun », « Jul », « Aug », « Sep », « Oct », « Nov » et « Dec ». La valeur renvoyée pointe sur une chaîne statiquement allouée qui sera écrasée à chaque appel ultérieur d'une fonction de date ou de temps. La fonction définit aussi les variables externes tzname, timezone et daylight comme si elle appelait tzset(3). La version réentrante ctime_r() effectue le même travail, mais stocke la chaîne dans un tampon d'une longueur minimale de 26 octets fourni par l'utilisateur. Elle n'a pas besoin de définir tzname, timezone et daylight.

La fonction gmtime() convertit le temps calendaire timep en une représentation humaine exprimée en temps universel (UTC). Elle peut renvoyer NULL quand l'année ne tient pas dans un entier. La valeur renvoyée pointe vers une structure allouée statiquement qui sera écrasée à chaque appel ultérieur d'une fonction de date ou de temps. La fonction réentrante gmtime_r() effectue le même travail, mais stocke le résultat dans une structure fournie par l'utilisateur.

La fonction localtime() convertit le temps calendaire timep en une représentation humaine exprimée en fonction du fuseau horaire de l'utilisateur. Cette fonction définit aussi les variables externes tzname, timezone et daylight comme si elle appelait tzset(3). La valeur renvoyée pointe vers une structure allouée statiquement qui sera écrasée à chaque appel ultérieur d'une fonction de date ou de temps. La fonction réentrante localtime_r() effectue le même travail, mais stocke le résultat dans une structure fournie par l'utilisateur. Elle n'a pas besoin de définir tzname, timezone, et daylight.

La fonction asctime() convertit une date au format humain tm en une chaîne de caractères terminée par un octet NULL dans le même format que ctime(). La valeur renvoyée pointe sur une chaîne allouée statiquement qui sera écrasée à chaque appel d'une fonction de date et de temps. La version réentrante asctime_r() effectue le même travail, mais stocke la chaîne dans un tampon d'une longueur minimale de 26 octets fourni par l'utilisateur.

La fonction mktime() convertit une structure de temps au format humain exprimée sous forme d'un temps local en une représentation de temps calendaire. La fonction ignore les valeurs tm_wday et tm_yday fournies par l'appelant. La valeur fournie dans le champ tm_isdst indique à mktime() si le décalage horaire d'été (DST) est pris en compte dans le temps fourni dans la structure tm : une valeur positive signifie que le décalage horaire d'été est effectif ; la valeur zéro signifie que le décalage horaire d'été n'est pas effectif ; une valeur négative signifie que mktime() doit déterminer si le décalage horaire d'été est effectif dans le temps spécifié (en utilisant les informations de fuseaux horaires et les bases de données du système). Voir timegm(3) pour un équivalent de cette fonction en UTC.

La fonction mktime() modifie des champs de la structure tm comme suit : les valeurs de tm_wday et tm_yday sont déterminées à partir des valeurs des autres champs ; si la valeur d'un membre de la structure n'est pas dans un intervalle autorisé, elle sera normalisée (par exemple, le 40 octobre sera converti en 9 novembre) ; tm_isdst est défini (indépendamment de sa valeur initiale) à une valeur positive si le décalage horaire d'été est effectif dans le temps spécifié, 0 sinon. La fonction définit aussi les variables externes tzname, timezone et daylight comme si elle appelait tzset(3).

Si la représentation du temps au format humain spécifié ne peut pas être convertie au format calendaire (nombre de secondes depuis l'Époque POSIX, 1er janvier 1970 à 00:00:00 (UTC)), mktime() renvoie la valeur (time_t) -1 et ne modifie pas les membres de la structure du temps au format humain.

VALEUR RENVOYÉE
S'ils réussissent, les appels gmtime() et localtime() renvoient un pointeur sur une struct tm.

S'ils réussissent, les appels gmtime_r() et localtime_r() renvoient l'adresse de la structure pointée par résultat.

S'ils réussissent, les appels asctime() et ctime() renvoient un pointeur sur une chaîne.

S'ils réussissent, les appels asctime_r() et ctime_r() renvoient un pointeur sur la chaîne pointée par tampon.

S'il réussit, l'appel mktime() renvoie le temps calendaire (nombre de secondes depuis l'Époque POSIX, 1er janvier 1970 à 00:00:00 (UTC)) exprimé sous la forme d'une valeur de type time_t.

En cas d'erreur, mktime() renvoie la valeur (time_t) -1 et laisse le membre tm->tm_wday inchangé. Les autres fonctions renvoient NULL en cas d’erreur. En cas d’erreur, errno est définie pour indiquer l’erreur.

ERREURS

EOVERFLOW
    Le résultat ne peut pas être représenté.

ATTRIBUTS
Pour une explication des termes utilisés dans cette section, consulter attributes(7).
Interface | Attribut | Valeur
asctime() | Sécurité des threads | MT-Unsafe race:asctime locale
asctime_r() | Sécurité des threads | MT-Safe locale
ctime() | Sécurité des threads | MT-Unsafe race:tmbuf race:asctime env locale
ctime_r(), gmtime_r(), localtime_r(), mktime() | Sécurité des threads | MT-Safe env locale
gmtime(), localtime() | Sécurité des threads | MT-Unsafe race:tmbuf env locale

VERSIONS
POSIX ne préconise pas restrict pour les paramètres de ctime_r() ; cela est spécifique à la glibc.

Dans de nombreuses implémentations, dont la glibc, un 0 dans tm_mday est interprété comme le dernier jour du mois précédent.

Selon POSIX.1, localtime() doit se comporter comme si tzset(3) avait été appelée, alors que localtime_r() n'est pas soumise à cette exigence. Pour un code portable, tzset(3) doit être appelée avant localtime_r().

NORMES

asctime()
ctime()
gmtime()
localtime()
mktime()
    C23, POSIX.1-2024.

gmtime_r()
localtime_r()
    POSIX.1-2024.

asctime_r()
ctime_r()
    Aucun.

HISTORIQUE

gmtime()
localtime()
mktime()
    C89, POSIX.1-1998.

asctime()
ctime()
    C89, POSIX.1-1988. Fonction marquée obsolète dans C23 et dans POSIX.1-2008 (recommandant strftime(3)).

gmtime_r()
localtime_r()
    POSIX.1-1996.

asctime_r()
ctime_r()
    POSIX.1-1996. Fonction marquée obsolète dans POSIX.1-2008 et supprimée dans POSIX.1-2024 (recommandant strftime(3)).

AVERTISSEMENTS

  Sécurité des threads
Les quatre fonctions asctime(), ctime(), gmtime() et localtime() renvoient un pointeur vers des données statiques et ne sont donc pas sûres dans un contexte multithread. Les versions sûres dans un contexte multithread, asctime_r(), ctime_r(), gmtime_r() et localtime_r() sont spécifiées dans SUSv2.

POSIX.1 indique : « Les fonctions asctime(), ctime(), gmtime() et localtime() renvoient les valeurs dans l'un de ces deux objets statiques : une structure de temps au format humain et un tableau de type char. L'exécution de n'importe laquelle des fonctions qui renvoient un pointeur vers un de ces types d’objet peut remplacer l'information dans tout objet du même type pointé par la valeur renvoyée par un appel précédent à n'importe laquelle d’entre elles ». Cela peut se produire dans l'implémentation de la glibc.

  mktime()
(time_t) -1 peut représenter un temps valable (une seconde avant l’Époch Posix). Pour voir si mktime() a échoué, utilisez le champ tm->tm_wday. Voir l’exemple de programme dans EXEMPLES.

La gestion d’un tm_isdst non négatif par mktime() est mal spécifiée, et passer une valeur de temps incorrecte peut conduire à des résultats imprévisibles. Comme mktime() est une des rares fonctions qui sait quand l’heure d’été est en action, fournir une valeur correcte peut s’avérer difficile. Pour contourner ce problème, appeler mktime() deux fois : une première fois avec tm_isdst défini à zéro, et une deuxième fois avec tm_isdst défini à une valeur positive et en rejetant les résultats de l'appel qui le modifie. Si aucun des appels ne modifie tm_isdst, le temps spécifié intervient probablement pendant une période de transition d’heure d’hiver (« fall-back ») où l’heure d’été débute ou se termine, et les deux résultats sont valables mais représentent des temps différents. Si les deux appels le modifient, cela pourrait indiquer une transition vers l’heure d’été (« fall-forward ») ou une autre raison pour laquelle le temps spécifié n’existe pas.

Les spécifications de fuseaux horaires et d’heure d’été sont à la charge des gouvernements régionaux, changent souvent, et peuvent comporter des discontinuités empêchant mktime de fournir un résultat. Par exemple, un changement dans la définition du fuseau horaire peut provoquer la répétition ou l’omission d’une heure d’horloge sans changement heure d’été/heure d’hiver correspondant.

EXEMPLES
Le programme ci-après constitue une enveloppe qui permet de détecter des temps non valables ou ambigus avec les codes d’erreur respectifs EINVAL et ENOTUNIQ.

La session d'interpréteur suivante montre un échantillon d'exécution du programme :

    $ TZ=UTC ./a.out 1969 12 31 23 59 59 0;
    -1
    $
    $ export TZ=Europe/Madrid;
    $
    $ ./a.out 2147483647 2147483647 00 00 00 00 -1;
    a.out: mktime: Valeur trop grande pour le type de données défini
    $
    $ ./a.out 2024 08 23 00 17 53 -1;
    1724365073
    $ ./a.out 2024 08 23 00 17 53 0;
    a.out: my_mktime: Argument non valable
    1724368673
    $ ./a.out 2024 08 23 00 17 53 1;
    1724365073
    $
    $ ./a.out 2024 02 23 00 17 53 -1;
    1708643873
    $ ./a.out 2024 02 23 00 17 53 0;
    1708643873
    $ ./a.out 2024 02 23 00 17 53 1;
    a.out: my_mktime: Argument non valable
    1708640273
    $
    $ ./a.out 2023 03 26 02 17 53 -1;
    a.out: my_mktime: Argument non valable
    1679793473
    $
    $ ./a.out 2023 10 29 02 17 53 -1;
    a.out: my_mktime: Nom non unique sur le réseau
    1698542273
    $ ./a.out 2023 10 29 02 17 53 0;
    1698542273
    $ ./a.out 2023 10 29 02 17 53 1;
    1698538673
    $
    $ ./a.out 2023 02 29 12 00 00 -1;
    a.out: my_mktime: Argument non valable
    1677668400

  Source du programme mktime.c
    #include <err.h>
    #include <errno.h>
    #include <stdint.h>
    #include <stdio.h>
    #include <stdlib.h>
    #include <string.h>
    #include <time.h>

    #define is_signed(T)  ((T) -1 < 1)

    static time_t my_mktime(struct tm *tp);

    int
    main(int argc, char *argv[])
    {
        char       **p;
        time_t     t;
        struct tm  tm;

        if (argc != 8) {
            fprintf(stderr, "Usage: %s yyyy mm dd HH MM SS isdst\n", argv[0]);
            exit(EXIT_FAILURE);
        }

        p = &argv[1];
        tm.tm_year  = atoi(*p++) - 1900;
        tm.tm_mon   = atoi(*p++) - 1;
        tm.tm_mday  = atoi(*p++);
        tm.tm_hour  = atoi(*p++);
        tm.tm_min   = atoi(*p++);
        tm.tm_sec   = atoi(*p++);
        tm.tm_isdst = atoi(*p++);

        errno = 0;
        tm.tm_wday = -1;
        t = my_mktime(&tm);
        if (tm.tm_wday == -1)
            err(EXIT_FAILURE, "mktime");
        if (errno == EINVAL || errno == ENOTUNIQ)
            warn("my_mktime");

        if (is_signed(time_t))
            printf("%jd\n", (intmax_t) t);
        else
            printf("%ju\n", (uintmax_t) t);

        exit(EXIT_SUCCESS);
    }

    static time_t
    my_mktime(struct tm *tp)
    {
        int            e, isdst;
        time_t         t;
        struct tm      tm;
        unsigned char  wday[sizeof(tp->tm_wday)];

        e = errno;

        tm = *tp;
        isdst = tp->tm_isdst;

        memcpy(wday, &tp->tm_wday, sizeof(wday));
        tp->tm_wday = -1;
        t = mktime(tp);
        if (tp->tm_wday == -1) {
            memcpy(&tp->tm_wday, wday, sizeof(wday));
            return -1;
        }

        if (isdst == -1)
            tm.tm_isdst = tp->tm_isdst;

        if (   tm.tm_sec   != tp->tm_sec
            || tm.tm_min   != tp->tm_min
            || tm.tm_hour  != tp->tm_hour
            || tm.tm_mday  != tp->tm_mday
            || tm.tm_mon   != tp->tm_mon
            || tm.tm_year  != tp->tm_year
            || tm.tm_isdst != tp->tm_isdst)
        {
            errno = EINVAL;
            return t;
        }

        if (isdst != -1)
            goto out;

        tm = *tp;
        tm.tm_isdst = !tm.tm_isdst;

        tm.tm_wday = -1;
        mktime(&tm);
        if (tm.tm_wday == -1)
            goto out;

        if (tm.tm_isdst != tp->tm_isdst) {
            errno = ENOTUNIQ;
            return t;
        }
    out:
        errno = e;
        return t;
    }

VOIR AUSSI
date(1), gettimeofday(2), time(2), utime(2), clock(3), difftime(3), strftime(3), strptime(3), timegm(3), tzset(3), time(7)

TRADUCTION
La traduction française de cette page de manuel a été créée par Christophe Blaess <https://www.blaess.fr/christophe/>, Stéphan Rafin <stephan.rafin@laposte.net>, Thierry Vignaud <tvignaud@mandriva.com>, François Micaux, Alain Portal <aportal@univ-montp2.fr>, Jean-Philippe Guérard <fevrier@tigreraye.org>, Jean-Luc Coulon (f5ibh) <jean-luc.coulon@wanadoo.fr>, Julien Cristau <jcristau@debian.org>, Thomas Huriaux <thomas.huriaux@gmail.com>, Nicolas François <nicolas.francois@centraliens.net>, Florentin Duneau <fduneau@gmail.com>, Simon Paillard <simon.paillard@resel.enst-bretagne.fr>, Denis Barbier <barbier@debian.org>, David Prévot <david@tilapin.org> et Lucien Gentis <lucien.gentis@waika9.com>

Cette traduction est une documentation libre ; veuillez vous reporter à la GNU General Public License version 3 (https://www.gnu.org/licenses/gpl-3.0.html) concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITÉ LÉGALE.

Si vous découvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message à debian-l10n-french@lists.debian.org.