DateTime_SetRange macro (commctrl.h)

Article
10/23/2024

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

Syntax

BOOL DateTime_SetRange(
   HWND         hdp,
   DWORD        gd,
   LPSYSTEMTIME rgst
);

Parameters

hdp

Type: HWND

A handle to a DTP control.

gd

Type: DWORD

A value that specifies which range values are valid. This value can be a combination of the following:

Value	Meaning
GDTR_MIN	The first element in the SYSTEMTIME structure array is valid and will be used to set the minimum allowable system time.
GDTR_MAX	The second element in the SYSTEMTIME structure array is valid and will be used to set the maximum allowable system time.

rgst

Type: LPSYSTEMTIME

A pointer to a two-element array of SYSTEMTIME structures. The first element of the SYSTEMTIME array contains the minimum allowable time. The second element of the SYSTEMTIME array contains the maximum allowable time. It is not necessary to fill an array element that is not specified in the gd parameter.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

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