|
Classes | |
class | Context |
Framework class for assisting in the writing of Back-ends. More... | |
struct | pan_beutil_time_t |
Structure for use with the pantheios_util_getCurrentTime() function. More... | |
Defines | |
#define | PANTHEIOS_GETCURRENTTIME_F_USE_SYSTEM_TIME (0x00000001) |
Indicates that pantheios_util_getCurrentTime() should express the time as system time (UTC). | |
#define | PANTHEIOS_GETCURRENTTIME_F_USE_UNIX_FORMAT (0x00000002) |
Indicates that pantheios_util_getCurrentTime() should use UNIX format regardless of actual operating system. | |
#define | PANTHEIOS_GETCURRENTTIME_F_HIDE_DATE (0x00000010) |
Indicates that pantheios_util_getCurrentTime() should hide the date component of the date/time field. | |
#define | PANTHEIOS_GETCURRENTTIME_F_HIDE_TIME (0x00000020) |
Indicates that pantheios_util_getCurrentTime() should hide the time component of the date/time field. | |
#define | PANTHEIOS_GETCURRENTTIME_F_TIME_RES_SECONDS (0x00000000) |
Indicates that pantheios_util_getCurrentTime() should use a time resolution of seconds. | |
#define | PANTHEIOS_GETCURRENTTIME_F_TIME_RES_TENTHS (0x00000100) |
Indicates that pantheios_util_getCurrentTime() should use a time resolution of tenths of seconds. | |
#define | PANTHEIOS_GETCURRENTTIME_F_TIME_RES_HUNDREDTHS (0x00000200) |
Indicates that pantheios_util_getCurrentTime() should use a time resolution of hundredths of seconds. | |
#define | PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MILLISECS (0x00000300) |
Indicates that pantheios_util_getCurrentTime() should use a time resolution of milliseconds. | |
#define | PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MICROSECS (0x00000600) |
Indicates that pantheios_util_getCurrentTime() should use a time resolution of microseconds. | |
#define | PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MAX PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MICROSECS |
The maximum time resolution available from pantheios_util_getCurrentTime(). | |
#define | PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MASK (0x00000f00) |
The time resolution mask used by pantheios_util_getCurrentTime(). | |
#define | PANTHEIOS_GETCURRENTTIME_F_FAVOUR_SPEED (0x00001000) |
Indicates that pantheios_util_getCurrentTime() should prefer execution speed over accuracy when preparing the time. | |
#define | PANTHEIOS_GETCURRENTTIME_F_FAVOUR_ACCURACY (0x00002000) |
Indicates that pantheios_util_getCurrentTime() should prefer accuracy over execution speed when preparing the time. | |
Functions | |
size_t | pantheios_util_getCurrentTime (pan_beutil_time_t *tm, int flags) |
Gets the current time in a suitable format. |
#define PANTHEIOS_GETCURRENTTIME_F_FAVOUR_ACCURACY (0x00002000) |
Indicates that pantheios_util_getCurrentTime() should prefer accuracy over execution speed when preparing the time.
#define PANTHEIOS_GETCURRENTTIME_F_FAVOUR_SPEED (0x00001000) |
Indicates that pantheios_util_getCurrentTime() should prefer execution speed over accuracy when preparing the time.
#define PANTHEIOS_GETCURRENTTIME_F_HIDE_DATE (0x00000010) |
Indicates that pantheios_util_getCurrentTime() should hide the date component of the date/time field.
#define PANTHEIOS_GETCURRENTTIME_F_HIDE_TIME (0x00000020) |
Indicates that pantheios_util_getCurrentTime() should hide the time component of the date/time field.
#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_HUNDREDTHS (0x00000200) |
Indicates that pantheios_util_getCurrentTime() should use a time resolution of hundredths of seconds.
#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MASK (0x00000f00) |
The time resolution mask used by pantheios_util_getCurrentTime().
#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MAX PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MICROSECS |
The maximum time resolution available from pantheios_util_getCurrentTime().
#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MICROSECS (0x00000600) |
Indicates that pantheios_util_getCurrentTime() should use a time resolution of microseconds.
#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MILLISECS (0x00000300) |
Indicates that pantheios_util_getCurrentTime() should use a time resolution of milliseconds.
#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_SECONDS (0x00000000) |
Indicates that pantheios_util_getCurrentTime() should use a time resolution of seconds.
#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_TENTHS (0x00000100) |
Indicates that pantheios_util_getCurrentTime() should use a time resolution of tenths of seconds.
#define PANTHEIOS_GETCURRENTTIME_F_USE_SYSTEM_TIME (0x00000001) |
Indicates that pantheios_util_getCurrentTime() should express the time as system time (UTC).
#define PANTHEIOS_GETCURRENTTIME_F_USE_UNIX_FORMAT (0x00000002) |
Indicates that pantheios_util_getCurrentTime() should use UNIX format regardless of actual operating system.
size_t pantheios_util_getCurrentTime | ( | pan_beutil_time_t * | tm, | |
int | flags | |||
) |
Gets the current time in a suitable format.
This function gets the current time, and formats it in an operating system-specific manner into the given pan_beutil_time_t instance, using either the local time or the system time (if the flags
parameter includes PANTHEIOS_GETCURRENTTIME_F_USE_SYSTEM_TIME).
Specifically, on Windows platforms the function formats according to the current locale settings. On UNIX, the function uses the syslog-standard format (strftimeFmt()
format: "%b %d %I:%M:%S"
) or the pan_beutil_time_t::strftimeFmt
member if it is non-NULL.
tm | Pointer to a pan_beutil_time_t instance, whose str and capacity members must be valid. May not be NULL. | |
flags | One or more of the PANTHEIOS_GETCURRENTTIME_F_* flags. |
|
|
pantheios Library documentation © Matthew Wilson & Synesis Software, 2006-2011 |