NAME

timespec_get — get time

SYNOPSIS

#include <time.h>

int timespec_get(struct timespec *ts, int base);


DESCRIPTION

^[CX] The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1-2024 defers to the ISO C standard.

The timespec_get() function shall set the interval pointed to by ts to hold the current calendar time based on the specified time base.

^[CX] If base is TIME_UTC, the members of ts shall be set to the same values as would be set by a call to clock_gettime(CLOCK_REALTIME, ts). If the number of seconds will not fit in an object of type time_t, the function shall return zero.

RETURN VALUE

If the timespec_get() function is successful it shall return the non-zero value base; otherwise, it shall return zero.

ERRORS

See DESCRIPTION.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

clock_getres , time

XBD <time.h>

CHANGE HISTORY

First released in Issue 8. Included for alignment with the ISO/IEC 9899:2018 standard.