]> git.saurik.com Git - apple/libc.git/blame - stdtime/FreeBSD/ftime.3
Libc-1439.100.3.tar.gz
[apple/libc.git] / stdtime / FreeBSD / ftime.3
CommitLineData
59e0d9fe 1.\" Copyright (c) 1980, 1991, 1993
e9ce8d39
A
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
59e0d9fe
A
32.\" @(#)ftime.3 8.1 (Berkeley) 6/4/93
33.\" $FreeBSD: /repoman/r/ncvs/src/lib/libcompat/4.1/ftime.3,v 1.11 2001/10/01 16:09:14 ru Exp $
e9ce8d39 34.\"
59e0d9fe
A
35.Dd June 4, 1993
36.Dt FTIME 3
e9ce8d39
A
37.Os
38.Sh NAME
59e0d9fe
A
39.Nm ftime
40.Nd get date and time
e9ce8d39 41.Sh SYNOPSIS
59e0d9fe 42.In sys/timeb.h
e9ce8d39 43.Ft int
ad3c9f2a
A
44.Fo ftime
45.Fa "struct timeb *tp"
46.Fc
e9ce8d39 47.Sh DESCRIPTION
59e0d9fe
A
48.Bf -symbolic
49This interface is obsoleted by
50.Xr gettimeofday 2 .
51.Ef
5b2abdfb 52.Pp
e9ce8d39 53The
59e0d9fe
A
54.Fn ftime
55routine fills in a structure pointed to by its argument,
56as defined by
57.Aq Pa sys/timeb.h :
58.Bd -literal -offset indent
59/*
60 * Structure returned by ftime system call
61 */
62struct timeb
63{
64 time_t time;
65 unsigned short millitm;
66 short timezone;
67 short dstflag;
68};
69.Ed
70.Pp
ad3c9f2a
A
71The structure contains the time since the epoch, in seconds;
72up to 1000 milliseconds of more-precise interval;
73the local time zone (measured in minutes of time westward from Greenwich);
59e0d9fe
A
74and a flag that, if nonzero, indicates that
75Daylight Saving time applies locally during the appropriate part of the year.
ad3c9f2a
A
76.Sh LEGACY SYNOPSIS
77.Fd #include <sys/types.h>
78.Fd #include <sys/timeb.h>
79.Pp
80The include file
81.In sys/types.h
82is necessary.
e9ce8d39 83.Sh SEE ALSO
59e0d9fe
A
84.Xr gettimeofday 2 ,
85.Xr settimeofday 2 ,
86.Xr ctime 3 ,
ad3c9f2a
A
87.Xr time 3 ,
88.Xr compat 5
59e0d9fe
A
89.Sh HISTORY
90The
91.Nm
92function appeared in
93.Bx 4.2 .