xref: /illumos-gate/usr/src/man/man3c/ftime.3c (revision 63f91fbc3c024870d86dc3332a4a0080fb29bc40)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions 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.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.

FTIME 3C "Jul 24, 2002"
NAME
ftime - get date and time
SYNOPSIS

#include <sys/timeb.h>

int ftime(struct timeb *tp);
DESCRIPTION

The ftime() function sets the time and millitm members of the timeb structure pointed to by tp. The structure is defined in <sys/timeb.h> and contains the following members:

time_t time;
unsigned short millitm;
short timezone;
short dstflag;

The time and millitm members contain the seconds and milliseconds portions, respectively, of the current time in seconds since 00:00:00 UTC (Coordinated Universal Time), January 1, 1970.

The timezone member contains the local time zone. The dstflag member contains a flag that, if non-zero, indicates that Daylight Saving time applies locally during the appropriate part of the year.

The contents of the timezone and dstflag members of tp after a call to ftime() are unspecified.

RETURN VALUES

Upon successful completion, the ftime() function returns 0. Otherwise -1 is returned.

ERRORS

No errors are defined.

USAGE

For portability to implementations conforming to earlier versions of this document, time(2) is preferred over this function.

The millisecond value usually has a granularity greater than one due to the resolution of the system clock. Depending on any granularity (particularly a granularity of one) renders code non-portable.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO

date (1), time (2), ctime (3C), gettimeofday (3C), timezone (5), attributes (7), standards (7)