COleDateTime::GetAsSystemTime

  • Article

Call this method to obtain the time in the COleDateTime object as a SYSTEMTIME data structure.

bool GetAsSystemTime( 
   SYSTEMTIME& sysTime  
) const throw( );

Parameters

  • sysTime
    A reference to a SYSTEMTIME structure to receive the converted date/time value from the COleDateTime object.

Return Value

Returns true if successful; false if the conversion fails, or if the COleDateTime object is NULL or invalid.

Remarks

GetAsSystemTime stores the resulting time in the referenced sysTime object. The SYSTEMTIME data structure initialized by this function will have its wMilliseconds member set to zero.

See GetStatus for more information on the status information held in a COleDateTime object.

Requirements

Header: atlcomtime.h

See Also

Reference

COleDateTime Class

Hierarchy Chart