summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2017/man3p/gettimeofday.3p
blob: d8d9a8e2737c6181f71082862eee8ece687aef99 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
'\" et
.TH GETTIMEOFDAY "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
gettimeofday
\(em get the date and time
.SH SYNOPSIS
.LP
.nf
#include <sys/time.h>
.P
int gettimeofday(struct timeval *restrict \fItp\fP, void *restrict \fItzp\fP);
.fi
.SH DESCRIPTION
The
\fIgettimeofday\fR()
function shall obtain the current time, expressed as seconds and
microseconds since the Epoch, and store it in the
.BR timeval
structure pointed to by
.IR tp .
The resolution of the system clock is unspecified.
.P
If
.IR tzp
is not a null pointer, the behavior is unspecified.
.SH "RETURN VALUE"
The
\fIgettimeofday\fR()
function shall return 0 and no value shall be reserved to indicate
an error.
.SH ERRORS
No errors are defined.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
Applications should use the
\fIclock_gettime\fR()
function instead of the obsolescent
\fIgettimeofday\fR()
function.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
The
\fIgettimeofday\fR()
function may be removed in a future version.
.SH "SEE ALSO"
.IR "\fIclock_getres\fR\^(\|)",
.IR "\fIctime\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<sys_time.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .