AIT_VerifyDefaultButton

Description

Checks whether a specific command button in the active window is the default button.

To Page Top

Format

integer AIT_VerifyDefaultButton  (
  string strCaption    // Control's caption
);
integer AIT_VerifyDefaultButton  (
  integer nCtrlID      // Control ID
);

To Page Top

Parameters

To Page Top

Return values

The return value is 1 if the button is the default one, 0 if not, and -1 if the function has not been processed successfully. If -1 has been returned, you can use AIT_GetLastError to acquire an extended error code. The following gives the error codes that AIT_GetLastError might return:

To Page Top

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.

To Page Top