AIT_GetDtPickerTime

Description

Acquires time for the date/time picker.

Format

bool AIT_GetDtPickerTime  (
 string strCaption,    // Control's caption
 string strOutTime     // Control time
 [,float fTimeOut]     // Time-out
);
bool AIT_GetDtPickerTime  (
 string strCaption,    // Control ID
 integer nHour,        // Hours
 integer nMinute,      // Minutes
 integer nSecond       // Seconds
 [,float fTimeOut]     // Time-out
);
bool AIT_GetDtPickerTime  (
 integer nCtrlID,      // Control ID
 string strOutTime     // Control time
 [,float fTimeOut]     // Time-out
);
bool AIT_SetDtPickerTime  (
 integer nCtrlID,      // Control ID
 integer nHour,        // Hours
 integer nMinute,      // Minutes
 integer nSecond       // Seconds
 [,float fTimeOut]     // Time-out
);

Parameters

strCaption (input)

Specify the caption of a control.

nCtrlID (input)

Specify a control ID.

strOutTime (output)

Sets a variable to receive a control time value. When the function returns, the variable stores the time value in the hh:mm:ss format where hh indicates the hour, mm indicates the minute, and ss indicates the second.

nHour (output)

Specify a variable to receive a control hour value. When the function returns, the variable stores the hour value.

nMinute (output)

Specify a variable to receive a control minute value. When the function returns, the variable stores the minute value.

nSecond (output)

Specify a variable to receive a control seconds value. When the function returns, the variable stores the seconds value.

fTimeOut (input, optional)

Specify the maximum time this function can use to find the control, in units of seconds. The default is the value 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 numberError code
6ERROR_INVALID_HANDLE
8ERROR_NOT_ENOUGH_MEMORY
14ERROR_OUTOFMEMORY
87ERROR_INVALID_PARAMETER
112ERROR_DISK_FULL
1400ERROR_INVALID_WINDOW_HANDLE
1460ERROR_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.