ftime (3p) - Linux Manuals

ftime: get date and time (LEGACY)

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.

NAME

ftime - get date and time (LEGACY)

SYNOPSIS

#include <sys/timeb.h>

int ftime(struct timeb *tp);

DESCRIPTION

The ftime() function shall set the time and millitm members of the timeb structure pointed to by tp to contain the seconds and milliseconds portions, respectively, of the current time in seconds since the Epoch. The contents of the timezone and dstflag members of tp after a call to ftime() are unspecified.

The system clock need not have millisecond granularity. Depending on any granularity (particularly a granularity of one) renders code non-portable.

RETURN VALUE

Upon successful completion, the ftime() function shall return 0; otherwise, -1 shall be returned.

ERRORS

No errors are defined.

The following sections are informative.

EXAMPLES

Getting the Current Time and Date

The following example shows how to get the current system time values using the ftime() function. The timeb structure pointed to by tp is filled with the current system time values for time and millitm.

#include <sys/timeb.h>


struct timeb tp;
int          status;
...
status = ftime(&tp);

APPLICATION USAGE

For applications portability, the time() function should be used to determine the current time instead of ftime(). Realtime applications should use clock_gettime() to determine the current time instead of ftime().

RATIONALE

None.

FUTURE DIRECTIONS

This function may be withdrawn in a future version.

COPYRIGHT

Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 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 .