.\"  Copyright 2001 walter harms (walter.harms@informatik.uni-oldenburg.de)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" Modified, 2001-12-26, aeb
.\"
.\" Traducido por Miguel Pérez Ibars <mpi79470@alu.um.es> el 25-julio-2004
.\"
.TH GETDATE 3 "26 diciembre 2001" "" "Manual del Programador de Linux"
.SH NOMBRE
getdate() \- convierte una cadena a una estructura tm
.br
.SH SINOPSIS
.B "#define _XOPEN_SOURCE"
.br
.B "#define _XOPEN_SOURCE_EXTENDED
.br
.B "#include <time.h>"
.sp
.BI "struct tm *getdate (const char *" string );
.sp
.BI "extern int getdate_err;"
.sp 2
.B "#define _GNU_SOURCE"
.br
.B "#include <time.h>"
.sp
.BI "int getdate_r (const char *" string ", struct tm *" res );
.br
.SH DESCRIPCIÓN
La función
.B getdate() 
convierte la cadena apuntada por
.I string
en una estructura tm que es devuelta por la función.
Esta estructura tm puede encontrarse en almacenamiento estático, por lo
que puede ser sobreescrita por una llamada posterior.

En contraste con
.BR strptime (3),
(que tiene un argumento
.I format
),
.B getdate()
usa los formatos situados en el fichero
del cual se especifica la ruta completa en la variable de entorno
.BR DATEMSK .
La primera línea del fichero que concuerde con la cadena de entrada
pasada se utiliza para la conversión.

La correspondencia se hace sin tener en cuenta las mayúsculas.
Los espacios  innecesarios, ya sea en el patrón o en la cadena que
debe ser convertida, se ignoran.

Las especificaciones de conversión que puede contener un patrón son aquellas
que proporciona
.BR strptime (3).
Se acepta una especificación de conversión adicional:
.TP
.B %Z
Nombre de la zona horaria.
.LP
Cuando se proporciona
.BR %Z ,
el valor que se devuelve se inicializa con el valor de tiempo descompuesto
correspondiente a la hora actual en la zona horaria dada.
En otro caso, se inicializa con el valor de tiempo descompuesto correspondiente
a la hora local actual.
.LP
Cuando sólo se especifica el día de la semana, el día que se toma es
el primero tras el día actual (que podría ser el propio día actual).
.LP
Cuando sólo se especifica el mes (y no el año), el mes que se toma es
el primero tras el mes actual (que podría ser el propio mes actual).
Si no se especifica el día, se toma el primer día del mes.
.LP
Cuando no se dan ni hora, ni minutos, ni segundos, se toman
la hora, minutos y segundos actuales.
.LP
Si no se especifica la fecha, pero sabemos la hora, entonces la hora
se toma para que sea la primera tras la hora actual (que podría ser la
propia hora actual).
.SH "VALOR DEVUELTO"
Cuando tiene éxito, esta función devuelve un puntero a una
.BR "estructura tm" .
En otro caso, devuelve NULL y modifica la variable global
.BR getdate_err .
Los cambios a
.I errno
son indefinidos. Se definen los siguientes valores para
.B getdate_err:
.TP 4n
.B 1
La variable de entorno DATEMSK es null o no está definida.
.TP
.B 2
No se ha podido abrir el fichero de plantillas para lectura.
.TP
.B 3
Fallo al obtener información del estado del fichero.
.TP
.B 4
El fichero de plantillas no es un fichero regular.
.TP
.B 5
Se ha producido un error al leer el fichero de plantillas.
.TP
.B 6
Fallo en la reserva de memoria (no hay suficiente memoria disponible).
.TP
.B 7
No hay ninguna línea en el fichero que concuerde con la entrada.
.TP
.B 8
Especificación inválida de entrada.
.SH OBSERVACIONES
Puesto que
.B getdate() 
no es reentrante debido al uso de
.B getdate_err
y al buffer estático que contiene el valor devuelto, glibc proporciona
una variante segura para hilos. La funcionalidad es la misma. El resultado
es devuelto en el buffer apuntado por
.I res
y en el caso de un error el valor devuelto es distinto de cero con los
mismos valores que los descritos arriba para
.IR getdate_err .
.LP
La especificación POSIX 1003.1-2001 para
.B strptime()
contiene especificaciones de conversión que usan el modificador
.B %E
o
.BR %O ,
mientras que tales especificaciones no se dan para
.BR getdate() .
La implementación de glibc implementa
.B getdate()
usando
.B strptime()
por lo que automáticamente las mismas conversiones son soportadas por ambas.
.LP
La implementación de glibc no soporta la especificación de conversión
.BR %Z .
.SH ENTORNO
.TP
.B DATEMSK 
Fichero que contiene patrones de formato.
.TP
.BR TZ ", " LC_TIME 
Variables usadas por \fBstrptime()\fP.
.SH "CONFORME A"
ISO 9899, POSIX 1003.1-2001
.SH "VÉASE TAMBIÉN"
.BR localtime (3),
.BR strftime (3),
.BR strptime (3),
.BR time (3)