AIT_GetDtPickerDate
- Organization of this page
Description
Acquires a date from the date/time picker.
Format
bool AIT_GetDtPickerDate ( string strCaption, // Control's caption string strOutDate // Control's date [,float fTimeOut] // Time-out ); bool AIT_GetDtPickerDate ( string strCaption, // Control's caption integer nYear, // Year integer nMonth, // Month integer nDay // Day [,float fTimeOut] // Time-out ); bool AIT_GetDtPickerDate ( integer nCtrlID, // Control ID string strOutDate // Control's date [,float fTimeOut] // Time-out ); bool AIT_GetDtPickerDate ( integer nCtrlID, // Control ID integer nYear, // Year integer nMonth, // Month integer nDay // Day [,float fTimeOut] // Time-out );
Parameters
strCaption (input)
Specify the caption of a control.
nCtrlID (input)
Specify a control ID.
strOutDate (output)
Specify a variable to receive the date value of a control. When the function returns, the variable stores the date in the MM/DD/YYYY format where MM indicates the month, DD indicates the day, and YYYY indicates the year.
nYear (output)
Specify a variable to receive a control's year value. When the function returns, the variable stores the year value.
nMonth (output)
Specify a variable to receive a control's month value. When the function returns, the variable stores the month value.
nDay (output)
Specify a variable to receive a control's day value. When the function returns, the variable stores the day value.
fTimeOut (input, optional)
Specify the maximum time this function can use to find the control, in units of seconds. The default is the time set in the AIT_SetDefaultWaitTimeout function.
Return values
The return value is true if the function was executed normally, and false if not. If the function has returned false, you can use AIT_GetLastError to acquire an extended error code. The following gives the error codes that AIT_GetLastError might return:
|
Extended error number |
Error code |
|---|---|
|
6 |
ERROR_INVALID_HANDLE |
|
8 |
ERROR_NOT_ENOUGH_MEMORY |
|
14 |
ERROR_OUTOFMEMORY |
|
87 |
ERROR_INVALID_PARAMETER |
|
112 |
ERROR_DISK_FULL |
|
1400 |
ERROR_INVALID_WINDOW_HANDLE |
|
1460 |
ERROR_TIMEOUT |
Note
You can identify the control by using a complete caption or an associated label name or specifying the first part of such a caption or label name. When specifying the first part, prefix a swung dash (~) to the character string that you specify.