xref: /netbsd-src/lib/libcompat/4.1/ftime.3 (revision 2a399c6883d870daece976daec6ffa7bb7f934ce)
1.\"	$NetBSD: ftime.3,v 1.6 1997/10/18 06:43:38 mikel Exp $
2.\"
3.\" Copyright (c) 1980, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)ftime.3	8.1 (Berkeley) 6/4/93
35.\"
36.Dd June 4, 1993
37.Dt FTIME 3
38.Os BSD 4
39.Sh NAME
40.Nm ftime
41.Nd get date and time
42.Sh SYNOPSIS
43.Fd #include <sys/types.h>
44.Fd #include <sys/timeb.h>
45.Ft int
46.Fn ftime "struct timeb *tp"
47.Sh DESCRIPTION
48.Bf -symbolic
49This interface is obsoleted by
50.Xr gettimeofday 2 .
51It is available from the compatibility library, libcompat.
52.Ef
53.Pp
54.Bf -symbolic
55Note: time zone information is no longer provided by this interface.
56See
57.Xr localtime 3
58for information on how to retrieve it.
59.Ef
60.Pp
61The
62.Fn ftime
63routine fills in a structure pointed to by its argument,
64as defined by
65.Aq Pa sys/timeb.h :
66.Bd -literal -offset indent
67struct timeb {
68	time_t  time;
69	unsigned short millitm;
70	short   timezone;
71	short   dstflag;
72};
73.Ed
74.Pp
75The structure contains the time since the epoch in seconds,
76up to 1000 milliseconds of more-precise interval.  The
77.Em timezone
78and
79.Em dstflag
80fields are provided for source compatibility, but are always zero.
81.Sh SEE ALSO
82.Xr gettimeofday 2 ,
83.Xr settimeofday 2 ,
84.Xr ctime 3 ,
85.Xr localtime 3 ,
86.Xr time 3 .
87.Sh HISTORY
88The
89.Fn ftime
90function appeared in
91.Bx 4.1 .
92