COleDateTime::SetStatus

void SetStatus( DateTimeStatus nStatus );

Parameters

nStatus

The new status value for this COleDateTime object.

Remarks

Call this member function to set the status of this COleDateTime object. The nStatus parameter value is defined by the DateTimeStatus enumerated type, which is defined within the COleDateTime class.

enum DateTimeStatus{
   valid = 0,
   invalid = 1,
   null = 2,
};

For a brief description of these status values, see the following list:

  • COleDateTime::valid   Indicates that this COleDateTime object is valid.

  • COleDateTime::invalid   Indicates that this COleDateTime object is invalid; that is, its value may be incorrect.

  • COleDateTime::null   Indicates that this COleDateTime object is null, that is, that no value has been supplied for this object. (This is “null” in the database sense of “having no value,” as opposed to the C++ NULL.)

Caution   This function is for advanced programming situations. This function does not alter the data in this object. It will most often be used to set the status to null or invalid. Note that the assignment operator (operator =) and SetDateTime do set the status of the object based on the source value(s).

Example

See the example for GetStatus.

COleDateTime OverviewClass MembersHierarchy Chart

See Also   COleDateTime::GetStatus, COleDateTime::operator =, COleDateTime::SetDateTime, COleDateTime::m_dt