RTEMS 4.9.5 On-Line Library

Clock Manager CLOCK_GET_TOD - Get date and time in TOD format

RTEMS C User's Guide

7.4.3: CLOCK_GET_TOD - Get date and time in TOD format

CALLING SEQUENCE:

rtems_status_code rtems_clock_get_tod(
  rtems_time_of_day *time_buffer
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - current time obtained successfully
RTEMS_NOT_DEFINED - system date and time is not set
RTEMS_INVALID_ADDRESS - time_buffer is NULL

DESCRIPTION:

This directive obtains the system date and time. If the date and time has not been set with a previous call to rtems_clock_set, then the RTEMS_NOT_DEFINED status code is returned.

NOTES:

This directive is callable from an ISR.

This directive will not cause the running task to be preempted. Re-initializing RTEMS causes the system date and time to be reset to an uninitialized state. Another call to rtems_clock_set is required to re-initialize the system date and time to application specific specifications.

RTEMS C User's Guide