winstl::to_SYSTEMTIME Time Conversion Shim
[Conversion Shims]

---

Detailed Description

These shims convert a given instance to an instance of the Windows type SYSTEMTIME.

Shim Definition:

• Name: winstl::to_SYSTEMTIME
• Intent: Converts a given instance to an instance of the Windows type SYSTEMTIME.
• Category: Conversion
• Ostensible Return Type: const SYSTEMTIME

• Degenerate Case(s): SYSTEMTIME const &to_SYSTEMTIME(SYSTEMTIME const &rhs)

Functions
const SYSTEMTIME	to_SYSTEMTIME (DATE const &rhs)
	Converts an instance of DATE to an instance of SYSTEMTIME, using the Windows API function VarUdateFromDate().
const SYSTEMTIME	to_SYSTEMTIME (FILETIME const &rhs)
	Converts an instance of FILETIME to an instance of SYSTEMTIME, using the Windows API function FileTimeToSystemTime().
SYSTEMTIME const &	to_SYSTEMTIME (SYSTEMTIME const &rhs)
	Degenerate case of the winstl::to_SYSTEMTIME Time Conversion Shim.
SYSTEMTIME const &	to_SYSTEMTIME (UDATE const &rhs)
	Degenerate case of the winstl::to_SYSTEMTIME Time Conversion Shim.

---

Function Documentation

SYSTEMTIME const& winstl::to_SYSTEMTIME

(

UDATE const &

rhs

)

[inline]

Degenerate case of the winstl::to_SYSTEMTIME Time Conversion Shim.

Parameters:

rhs

An instance of type UDATE

Returns:

An instance of type SYSTEMTIME

Exceptions:

-

No error checking is performed, and no exception can be thrown.

SYSTEMTIME const& winstl::to_SYSTEMTIME

(

SYSTEMTIME const &

rhs

)

[inline]

Degenerate case of the winstl::to_SYSTEMTIME Time Conversion Shim.

Parameters:

rhs

An instance of type SYSTEMTIME

Returns:

An instance of type SYSTEMTIME

Exceptions:

-

No error checking is performed, and no exception can be thrown.

const SYSTEMTIME winstl::to_SYSTEMTIME

(

FILETIME const &

rhs

)

[inline]

Converts an instance of FILETIME to an instance of SYSTEMTIME, using the Windows API function FileTimeToSystemTime().

Parameters:

rhs

A valid date, of type FILETIME

Returns:

A valid date, of type SYSTEMTIME

Exceptions:

winstl::conversion_error

If the conversion fails, e.g. the FILETIME instance does not contain a valid date. When compiling absent exception support, a zero-initialised instance of SYSTEMTIME is returned.

References winstl::zero_struct().

const SYSTEMTIME winstl::to_SYSTEMTIME

(

DATE const &

rhs

)

[inline]

Converts an instance of DATE to an instance of SYSTEMTIME, using the Windows API function VarUdateFromDate().

Parameters:

rhs

A valid date, of type DATE

Returns:

A valid date, of type SYSTEMTIME

Exceptions:

winstl::conversion_error

If the conversion fails, e.g. the DATE instance does not contain a valid date. When compiling absent exception support, a zero-initialised instance of SYSTEMTIME is returned.

References winstl::zero_struct().

Referenced by winstl::FILETIME2SYSTEMTIME(), winstl::to_DATE(), and winstl::to_FILETIME().