Job Management Partner 1/Software Distribution Automatic Installation Tool Description and Reference

[Contents][Glossary][Index][Back][Next]

AIT_SelectIPAddressField

Description

Selects a text in the IP address control on the active window.

Format

bool AIT_SelectIPAddressField  (
  string strCaption,       // Control's caption
  integer nFieldIndex,     // Field index
  integer nStartSel,       // Text start position
  integer nEndSel          // Text count
  [,float fTimeOut]        // Time-out
); 
bool AIT_SelectIPAddressField  (
  integer nCtrlID,         // Control ID
  integer nFieldIndex,     // Field index
  integer nStartSel,       // Text start position
  integer nEndSel          // Text count
  [,float fTimeOut]        // Time-out
); 

Parameters

strCaption (input)

Specify the control's caption.

nCtrlID (input)

Specify the control ID.

nFieldIndex (input)

Specify the index of a field in the IP address control. The default index value is 0.

nStartSel (input)

Specify the start character position at which to select text. The default nStartSel value is 0, corresponding to the first text character.

nEndSel (input)

Specify the number of texts you want to select.

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 may 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.

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.