NAME

ftime - get date and time (LEGACY)

SYNOPSIS

[XSI] #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.

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.

SEE ALSO

clock_getres(), ctime(), gettimeofday(), time(), the Base Definitions volume of IEEE Std 1003.1-2001, <sys/timeb.h>

CHANGE HISTORY

First released in Issue 4, Version 2.

Issue 5

Moved from X/OPEN UNIX extension to BASE.

Normative text previously in the APPLICATION USAGE section is moved to the DESCRIPTION.

Issue 6

This function is marked LEGACY.

The DESCRIPTION is updated to refer to "seconds since the Epoch" rather than "seconds since 00:00:00 UTC (Coordinated Universal Time), January 1 1970" for consistency with other time functions.