DateTime_GetRange macro (commctrl.h)

Article
10/23/2024

Gets the current minimum and maximum allowable system times for a date and time picker (DTP) control. You can use this macro, or send the DTM_GETRANGE message explicitly.

Syntax

DWORD DateTime_GetRange(
   HWND         hdp,
   LPSYSTEMTIME rgst
);

Parameters

hdp

Type: HWND

A handle to a DTP control.

rgst

Type: LPSYSTEMTIME

A pointer to a two-element array of SYSTEMTIME structures.

Return value

Type: DWORD

Returns a DWORD value that is a combination of GDTR_MIN or GDTR_MAX. The first element of the SYSTEMTIME array contains the minimum allowable time. The second element of the SYSTEMTIME array contains the maximum allowable time.

Remarks

The date and time picker displays only dates/times that fall within the specified range, preventing the user from selecting a date and time that falls outside the range. If the DateTime_SetSystemtime message specifies a date and time that falls outside the range, it will fail.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	commctrl.h

Share via