winstl::to_FILETIME Time Conversion Shim
[Conversion Shims]

---

Detailed Description

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

Shim Definition:

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

• Degenerate Case(s): FILETIME const &to_FILETIME(FILETIME const &rhs)

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

---

Function Documentation

const FILETIME winstl::to_FILETIME

(

UDATE const &

rhs

)

[inline]

Converts an instance of UDATE to an instance of FILETIME.

Parameters:

rhs

A valid date, of type UDATE

Returns:

A valid date, of type FILETIME

Exceptions:

winstl::conversion_error

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

References winstl::to_FILETIME().

const FILETIME winstl::to_FILETIME

(

SYSTEMTIME const &

rhs

)

[inline]

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

Parameters:

rhs

A valid date, of type SYSTEMTIME

Returns:

A valid date, of type FILETIME

Exceptions:

winstl::conversion_error

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

References winstl::zero_struct().

FILETIME const& winstl::to_FILETIME

(

FILETIME const &

rhs

)

throw () [inline]

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

Parameters:

rhs

An instance of type FILETIME

Returns:

An instance of type FILETIME

Exceptions:

-

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

const FILETIME winstl::to_FILETIME

(

DATE const &

rhs

)

[inline]

Converts an instance of DATE to an instance of FILETIME.

Parameters:

rhs

A valid date, of type DATE

Returns:

A valid date, of type FILETIME

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 FILETIME is returned.

References winstl::to_SYSTEMTIME().

Referenced by winstl::to_FILETIME().