Namespaces
Variants

localtime, localtime_r, localtime_s

From cppreference.net
C
Date and time utilities
Functions
Time manipulation
(C11)
(C23)
Format conversions
(deprecated in C23) (C11)
(deprecated in C23) (C11)
(C95)
(C23) (C11)
localtime localtime_r localtime_s
(C23) (C11)
Constants
Types
(C11)
Definido en el encabezado <time.h>
struct tm * localtime ( const time_t * timer ) ;
(1)
struct tm * localtime_r ( const time_t * timer, struct tm * buf ) ;
(2) (desde C23)
struct tm * localtime_s ( const time_t * restrict timer, struct tm * restrict buf ) ;
(3) (desde C11)
1) Convierte el tiempo transcurrido desde la época (un valor time_t apuntado por timer ) a tiempo calendario, expresado en hora local, en el formato struct tm . El resultado se almacena en almacenamiento estático y se devuelve un puntero a dicho almacenamiento estático.
2) Igual que (1) , excepto que la función utiliza el almacenamiento proporcionado por el usuario buf para el resultado.
3) Igual que (1) , excepto que la función utiliza almacenamiento proporcionado por el usuario buf para el resultado y que los siguientes errores se detectan en tiempo de ejecución y llaman a la función constraint handler actualmente instalada:
  • timer o buf es un puntero nulo
Como con todas las funciones con verificación de límites, localtime_s solo está garantizada que esté disponible si __STDC_LIB_EXT1__ está definido por la implementación y si el usuario define __STDC_WANT_LIB_EXT1__ como la constante entera 1 antes de incluir <time.h> .

Contenidos

Parámetros

timer - puntero a un objeto time_t a convertir
buf - puntero a un objeto struct tm para almacenar el resultado

Valor de retorno

1) puntero a un objeto interno estático tm en caso de éxito, o puntero nulo en caso contrario. La estructura puede ser compartida entre gmtime , localtime , y ctime y puede ser sobrescrita en cada invocación.
2,3) copia del puntero buf , o puntero nulo en caso de error (lo cual puede ser una violación de restricción en tiempo de ejecución o un fallo al convertir el tiempo especificado a hora local del calendario).

Notas

La función localtime puede no ser segura para subprocesos. La implementación de Microsoft CRT es segura para subprocesos.

POSIX requiere que localtime y localtime_r establezcan errno a EOVERFLOW si falla porque el argumento es demasiado grande.

POSIX especifica que la información de la zona horaria es determinada por localtime y localtime_r como si se llamara a tzset , que lee la variable de entorno TZ .

La implementación de localtime_s en Microsoft CRT es incompatible con el estándar C ya que tiene el orden de parámetros invertido y retorna errno_t .

Ejemplo

Ejecutar este código 
#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
}

Salida posible: 

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

Referencias

  • Estándar C23 (ISO/IEC 9899:2024):
  • 7.27.3.4 La función localtime (p: TBD)
  • K.3.8.2.4 La función localtime_s (p: TBD)
  • Estándar C17 (ISO/IEC 9899:2018):
  • 7.27.3.4 La función localtime (p: 288)
  • K.3.8.2.4 La función localtime_s (p: 455)
  • Estándar C11 (ISO/IEC 9899:2011):
  • 7.27.3.4 La función localtime (p: 394)
  • K.3.8.2.4 La función localtime_s (p: 627)
  • Estándar C99 (ISO/IEC 9899:1999):
  • 7.23.3.4 La función localtime (p: 343)
  • Estándar C89/C90 (ISO/IEC 9899:1990):
  • 4.12.3.4 La función localtime

Véase también

(C23) (C11)
convierte el tiempo desde la época a tiempo calendario expresado como Tiempo Universal Coordinado (UTC)
(función)
Documentación de C++ para localtime