CDateTimeCtrl::GetRange

DWORD GetRange( COleDateTime* pMinRange, COleDateTime* pMaxRange ) const;

DWORD GetRange( CTime* pMinRange, CTime* pMaxRange ) const;

Return Value

A DWORD value containing flags that indicate which ranges are set.

Parameters

pMinRange

A pointer to a COleDateTime object or a CTime object containing the earliest time allowed in the CDateTimeCtrl object.

pMaxRange

A pointer to a COleDateTime object or a CTime object containing the latest time allowed in the CDateTimeCtrl object.

Remarks

This member function implements the behavior of the Win32 message DTM_GETRANGE, as described in the Platform SDK.

In MFC's implementation, you can specify either COleDateTime or CTime usages.

Example

// This function will set several ranges in the control, then
// call the ShowRange() function to show the set ranges to the
// user.

void CDatesDlg::OnButton2() 
{
   // Gain a pointer to the control
   // CMonthCalCtrl* pCtrl = (CMonthCalCtrl*) 
   // GetDlgItem(IDC_MONTHCALENDAR1);
   CDateTimeCtrl* pCtrl = (CDateTimeCtrl*) GetDlgItem(IDC_DATETIMEPICKER1);
   ASSERT(pCtrl != NULL);

   // Set minimum of January 1st, 1995 with no maximum.
   COleDateTime dtMin;
   COleDateTime dtMax;

   dtMin = COleDateTime(1995, 1, 1, 0, 0, 0);
   dtMax.SetStatus(COleDateTime::null);
   pCtrl->SetRange(&dtMin, &dtMax);
   ShowRange(pCtrl);

   // Set no minimum and maximum of September 30th, 1997.
   dtMin.SetStatus(COleDateTime::null);
   dtMax = COleDateTime(1997, 9, 30, 0, 0, 0);
   pCtrl->SetRange(&dtMin, &dtMax);
   ShowRange(pCtrl);

   // Set minimum of April 15, 1992 and maximum of June 5, 2002.
   dtMin = COleDateTime(1992, 4, 15, 0, 0, 0);
   dtMax = COleDateTime(2002, 6, 5, 0, 0, 0);
   pCtrl->SetRange(&dtMin, &dtMax);
   ShowRange(pCtrl);
}

void CDatesDlg::ShowRange(CDateTimeCtrl* pCtrl)
{
   ASSERT(pCtrl != NULL);
   CString strMessage;
   COleDateTime dtMinimum;
   COleDateTime dtMaximum;

   // Get the range.
   DWORD dwResult = pCtrl->GetRange(&dtMinimum, &dtMaximum);

   // If a minimum was specified, format it.
   // Otherwise, indicate that there is no lower bound.
   if (dwResult & GDTR_MIN)
      strMessage += dtMinimum.Format(_T("Minimum range is %x %X.\r\n"));
   else
      strMessage += _T("No minimum range.\r\n");

   // Treat maximum similarly.
   if (dwResult & GDTR_MAX)
      strMessage += dtMaximum.Format(_T("Maximum range is %x %X.\r\n"));
   else
      strMessage += _T("No maximum range.\r\n");

   // Show the user.
   AfxMessageBox(strMessage);
}

CDateTimeCtrl Overview |  Class Members |  Hierarchy Chart

See Also   CDateTimeCtrl::SetRange