include/pantheios/util/be/time.h File Reference

---

Detailed Description

[C, C++] Time utility functions used in the implementation of the Pantheios core and some back-end libraries.

#include <pantheios/pantheios.h>

Go to the source code of this file.

Classes
struct	pan_beutil_time_t
	Structure for use with the pantheios_util_getCurrentTime() function. More...
Functions
size_t	pantheios_util_getCurrentTime (pan_beutil_time_t *tm, int bUseSystemTime)
	Gets the current time in a suitable format.

---

Function Documentation

size_t pantheios_util_getCurrentTime (  pan_beutil_time_t *  tm, int  bUseSystemTime )

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 bUseSystemTime parameter is non-zero). 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. Parameters: tm  Pointer to a pan_beutil_time_t instance, whose str and capacity members must be valid. May not be NULL. bUseSystemTime  If non-zero, the system time (GMT) will be used. If zero, the local time will be used.

pantheios Library documentation © Matthew Wilson, 2006