Hitachi

JP1 Version 12 JP1/IT Desktop Management 2 Distribution Function Administration Guide


AIT_SetComboEditSelText

Organization of this page

Description

Sets text selection in a combo box on the active window.

Format

bool AIT_SetComboEditSelText  (
  string strCaption,    // Control's caption
  integer nStartSel,    // Control start position
  integer nEndSel       // Control end position
  [,float fTimeOut]     // Time-out
); 
bool AIT_SetComboEditSelText  (
  integer nCtrlID,      // Control's caption
  integer nStartSel,    // Control start position
  integer nEndSel       // Control end position
  [,float fTimeOut]     // Time-out
);

Parameters

strCaption (input)

Specify the caption of a control.

nCtrlID (input)

Specify a control ID.

nStartSel (input)

Specify the start position of text selection in an edit control. The default nStartSel value is 0.

nEndSel (input)

Specify the end position of text selection in an edit control.

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 number

Error code

8

ERROR_NOT_ENOUGH_MEMORY

14

ERROR_OUTOFMEMORY

87

ERROR_INVALID_PARAMETER

112

ERROR_DISK_FULL

1400

ERROR_INVALID_WINDOW_HANDLE

1460

ERROR_TIMEOUT

Notes

The start value may be greater than the end value. The smaller of the two values refers to the first character position of selected text. The greater value refers to the first character position beyond selected text.

The start value is a fixed selected text point, while the end value is a varying end point. The user can use the Shift key to adjust the size of a selected text. If the start point is 0 and the end point is -1, all the texts in the edit control are selected. If the start point is -1, active selection is released.

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.