AutoTest
Class AutoIt3

java.lang.Object
  AutoTest.AutoIt3

public class AutoIt3
extends java.lang.Object

Nested Class Summary

static class	AutoIt3.ByReferenceBoolean
static class	AutoIt3.ByReferenceDouble
static class	AutoIt3.ByReferenceInteger
static class	AutoIt3.ByReferenceLong
static class	AutoIt3.ByReferenceString

Constructor Summary

AutoIt3()

Method Summary

void	BlockInput(int nToggle) Documentation for: BlockInput Will prevent any user input via the mouse or keyboard.
void	CDTray(java.lang.String szDrive, java.lang.String szAction) Documentation for: CDTray Controls CD tray of a local system.
void	ClipGet(AutoIt3.ByReferenceString szClip, int nBufSize) Documentation for: ClipGet Allows you to get text from the clipboard.
void	ClipPut(java.lang.String szClip) Documentation for: ClipPut Allows you to get text from the clipboard.
int	ControlClick(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl, java.lang.String szButton, int nNumClicks) Documentation for: ControlClick Sends a mouse click command to a given control.
void	ControlCommand(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl, java.lang.String szCommand, java.lang.String szExtra, AutoIt3.ByReferenceString szResult, int nBufSize) Documentation for: ControlCommand Sends a command to a control.
int	ControlDisable(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl) Documentation for: ControlDisable Disables or "grays-out" a control.
int	ControlEnable(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl) Documentation for: ControlEnable
int	ControlFocus(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl) Documentation for: ControlFocus Sets input focus to a given control on a window.
void	ControlGetFocus(java.lang.String szTitle, java.lang.String szText, AutoIt3.ByReferenceString szControlWithFocus, int nBufSize) Documentation for: ControlGetFocus Returns the ControlRef# of the control that has keyboard focus within a specified window.
void	ControlGetHandle(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl, AutoIt3.ByReferenceString szRetText, int nBufSize) Documentation for: ControlGetHandle Retrieves the internal handle of a control.
int	ControlGetPosHeight(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl) Documentation for: ControlGetPosHeight Returns the height of a window.
int	ControlGetPosWidth(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl) Documentation for: ControlGetPosWidth Returns the width of a window.
int	ControlGetPosX(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl) Documentation for: ControlGetPosX Returns the X position of a window.
int	ControlGetPosY(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl) Documentation for: ControlGetPosY Returns the Y position of a window.
void	ControlGetText(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl, AutoIt3.ByReferenceString szControlText, int nBufSize) Documentation for: ControlGetText Retrieves text from a control.
int	ControlHide(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl) Documentation for: ControlHide Hides a control
void	ControlListView(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl, java.lang.String szCommand, java.lang.String szExtra1, java.lang.String szExtra2, AutoIt3.ByReferenceString szResult, long nBufSize) Documentation for: ControlListView Sends a command to a ListView32 control.
int	ControlMove(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl, int nX, int nY, int nWidth, int nHeight) Documentation for: ControlMove Moves a control within a window.
int	ControlSend(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl, java.lang.String szSendText, int nMode) Documentation for: ControlSend Sends a string of characters to a control.
int	ControlSetText(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl, java.lang.String szControlText) Documentation for: ControlSetText Sets text of a control.
int	ControlShow(java.lang.String szTitle, java.lang.String szText, java.lang.String szControl) Documentation for: ControlShow Shows a control that was hidden.
void	DriveMapAdd(java.lang.String szDevice, java.lang.String szShare, int nFlags, java.lang.String szUser, java.lang.String szPwd, AutoIt3.ByReferenceString szResult, int nBufSize) Documentation for: DriveMapAdd Maps a network drive.
int	DriveMapDel(java.lang.String szDevice) Documentation for: DriveMapDel Disconnects a network drive.
void	DriveMapGet(java.lang.String szDevice, AutoIt3.ByReferenceString szMapping, int nBufSize) Documentation for: DriveMapGet Retreives the details of a mapped drive.
int	IniDelete(java.lang.String szFilename, java.lang.String szSection, java.lang.String szKey) Documentation for: IniDelete Deletes a value from a standard format .ini file.
void	IniRead(java.lang.String szFileName, java.lang.String szSection, java.lang.String szKey, java.lang.String szDefault, AutoIt3.ByReferenceString szValue, int nBufSize) Documentation for: IniRead Reads a value from a standard format .ini file.
void	Init() Documentation for: Init Resets AutoIt to defaults (window delays, key delays, etc.).
int	IniWrite(java.lang.String szFileName, java.lang.String szSection, java.lang.String szKey, java.lang.String szValue) Documentation for: IniWrite Writes a value to a standard format .ini file.
int	IsAdmin() Documentation for: IsAdmin Checks if the current user has administrator privileges.
int	MouseClick(java.lang.String szButton, int nX, int nY, int nClicks, int nSpeed) Documentation for: MouseClick Perform a mouse click operation.
int	MouseClickDrag(java.lang.String szButton, int nX1, int nY1, int nX2, int nY2, int nSpeed) Documentation for: MouseClickDrag Perform a mouse click and drag operation.
void	MouseDown(java.lang.String szButton) Documentation for: MouseDown Perform a mouse down event at the current mouse position.
int	MouseGetCursor() Documentation for: MouseGetCursor Returns a cursor ID Number: 0 = UNKNOWN (this includes pointing and grabbing hand icons) 1 = APPSTARTING 2 = ARROW 3 = CROSS 4 = HELP 5 = IBEAM 6 = ICON 7 = NO 8 = SIZE 9 = SIZEALL 10 = SIZENESW 11 = SIZENS 12 = SIZENWSE 13 = SIZEWE 14 = UPARROW 15 = WAIT
int	MouseGetPosX() Documentation for: MouseGetPosX Gets the X coordinate of the mouse pointer.
int	MouseGetPosY() Documentation for: MouseGetPosY Gets the Y coordinate of the mouse pointer.
int	MouseMove(int nX, int nY, int nSpeed) Documentation for: MouseMove Moves the mouse pointer to the specified coordinates.
void	MouseUp(java.lang.String szButton) Documentation for: MouseUp Perform a mouse up event at the current mouse position.
void	MouseWheel(java.lang.String szDirection, int nClicks) Documentation for: MouseWheel Moves the mouse wheel up or down.
int	Opt(java.lang.String szOption, int nValue) Documentation for: Opt This option will set Function options in AutoIT.
int	PixelChecksum(int nLeft, int nTop, int nRight, int nBottom, int nStep) Documentation for: PixelChecksum Generates a checksum for a region of pixels.
int	PixelGetColor(int nX, int nY) Documentation for: PixelGetColor Returns a pixel color according to x,y pixel coordinates.
void	PixelSearch(int nLeft, int nTop, int nRight, int nBottom, int nCol, int nVar, int nStep, AutoIt3.ByReferenceString szResult, int nBufSize) Documentation for: PixelSearch Searches a rectangle of pixels for the pixel color provided.
int	ProcessClose(java.lang.String szProcess) Documentation for: ProcessClose Terminates a named process.
int	ProcessExists(java.lang.String szProcess) Documentation for: ProcessExists Checks to see if a specified process exists.
int	ProcessSetPriority(java.lang.String szProcess, int nPriority) Documentation for: ProcessSetPriority Changes the priority of a process
int	ProcessWait(java.lang.String szProcess, int nTimeout) Documentation for: ProcessWait Pauses script execution until a given process exists.
int	ProcessWaitClose(java.lang.String szProcess, int nTimeout) Documentation for: ProcessWaitClose Pauses script execution until a given process does not exist.
int	RegDeleteKey(java.lang.String szKeyName) Documentation for: RegDeleteKey Deletes a key or value from the registry.
int	RegDeleteVal(java.lang.String szKeyName, java.lang.String szValuename) Documentation for: RegDeleteVal Deletes a key or value from the registry.
void	RegEnumKey(java.lang.String szKeyName, int nInstance, AutoIt3.ByReferenceString szResult, int nBufSize) Documentation for: RegEnumKey Reads the name of a subkey according to it's instance.
void	RegEnumVal(java.lang.String szKeyName, int nInstance, AutoIt3.ByReferenceString szResult, int nBufSize) Documentation for: RegEnumVal Reads the name of a value according to it's instance.
void	RegRead(java.lang.String szKeyName, java.lang.String szValuename, AutoIt3.ByReferenceString szRetText, int nBufSize) Documentation for: RegRead Reads a value from the registry.
int	RegWrite(java.lang.String szKeyName, java.lang.String szValueName, java.lang.String szType, java.lang.String szValue) Documentation for: RegWrite Creates a key or value in the registry.
int	Run(java.lang.String szRun, java.lang.String szDir, int nShowFlags) Documentation for: Run Runs an external program.
int	RunAsSet(java.lang.String szUser, java.lang.String szDomain, java.lang.String szPassword, int nOptions) Documentation for: RunAsSet Initialise a set of user credentials to use during Run and RunWait operations.
int	RunWait(java.lang.String szRun, java.lang.String szDir, int nShowFlags) Documentation for: RunWait Runs an external program and pauses script execution until the program finishes.
void	Send(java.lang.String szSentText, int nMode) Documentation for: Send Set an error message.
int	Shutdown(int nFlag) Documentation for: Shutdown This function can perform various types of shutdown on all Windows operating systems.
void	Sleep(int nMilliseconds) Documentation for: Sleep This function simply pauses for an amount of time.
void	StatusbarGetText(java.lang.String szTitle, java.lang.String szText, int nPart, AutoIt3.ByReferenceString szStatusText, int nBufSize) Documentation for: StatusbarGetText Retrieves the text from a standard status bar control.
void	ToolTip(java.lang.String szTip, int nX, int nY) Documentation for: ToolTip Creates a tooltip anywhere on the screen.
void	WinActivate(java.lang.String szTitle, java.lang.String szText) Documentation for: WinActivate This function will activate a specified window.
int	WinActive(java.lang.String szTitle, java.lang.String szText) Documentation for: WinActive Checks if a given window is currently active.
int	WinClose(java.lang.String szTitle, java.lang.String szText) Documentation for: WinClose This function will close a specified window
int	WinExists(java.lang.String szTitle, java.lang.String szText) Documentation for: WinExists Checks if a given window current exists (in any state).
int	WinGetCaretPosX() Documentation for: WinGetCaretPosX Returns a 2-element array containing the following information: array[0] = X coordinate
int	WinGetCaretPosY() Documentation for: WinGetCaretPosY Returns a 2-element array containing the following information: array[1] = Y coordinate
void	WinGetClassList(java.lang.String szTitle, java.lang.String szText, AutoIt3.ByReferenceString szRetText, int nBufSize) Documentation for: WinGetClassList Retrieves the classes from a window.
int	WinGetClientSizeHeight(java.lang.String szTitle, java.lang.String szText) Documentation for: WinGetClientSizeHeight Retrieves the size of a given window's client area.
int	WinGetClientSizeWidth(java.lang.String szTitle, java.lang.String szText) Documentation for: WinGetClientSizeWidth Retrieves the size of a given window's client area.
void	WinGetHandle(java.lang.String szTitle, java.lang.String szText, AutoIt3.ByReferenceString szRetText, int nBufSize) Documentation for: WinGetHandle A string pointer to receive the window title.
int	WinGetPosHeight(java.lang.String szTitle, java.lang.String szText) Documentation for: WinGetPosHeight Retrieves the height of a given window.
int	WinGetPosWidth(java.lang.String szTitle, java.lang.String szText) Documentation for: WinGetPosWidth Retrieves the width of a given window.
int	WinGetPosX(java.lang.String szTitle, java.lang.String szText) Documentation for: WinGetPosX Retrieves the position and size of a given window.
int	WinGetPosY(java.lang.String szTitle, java.lang.String szText) Documentation for: WinGetPosY Retrieves the position and size of a given window.
void	WinGetProcess(java.lang.String szTitle, java.lang.String szText, AutoIt3.ByReferenceString szRetText, int nBufSize) Documentation for: WinGetProcess Retrieves the Process ID (PID) associated with a window
int	WinGetState(java.lang.String szTitle, java.lang.String szText) Documentation for: WinGetState Returns a value indicating the state of the window.
void	WinGetText(java.lang.String szTitle, java.lang.String szText, AutoIt3.ByReferenceString szRetText, int nBufSize) Documentation for: WinGetText Retrieves the text from a window.
void	WinGetTitle(java.lang.String szTitle, java.lang.String szText, AutoIt3.ByReferenceString szRetText, int nBufSize) Documentation for: WinGetTitle Retrieves the title from a window.
int	WinKill(java.lang.String szTitle, java.lang.String szText) Documentation for: WinKill This function will forceably close a specified window.
int	WinMenuSelectItem(java.lang.String szTitle, java.lang.String szText, java.lang.String szItem1, java.lang.String szItem2, java.lang.String szItem3, java.lang.String szItem4, java.lang.String szItem5, java.lang.String szItem6, java.lang.String szItem7, java.lang.String szItem8) Documentation for: WinMenuSelectItem Invokes a menu item of a window.
void	WinMinimizeAll() Documentation for: WinMinimizeAll This function will minimize all windows.
void	WinMinimizeAllUndo() Documentation for: WinMinimizeAllUndo This function will undo a previous WinMinimizeAll call.
int	WinMove(java.lang.String szTitle, java.lang.String szText, int nX, int nY, int nWidth, int nHeight) Documentation for: WinMove Use this function to move/resize a specified window.
int	WinSetOnTop(java.lang.String szTitle, java.lang.String szText, int nFlag) Documentation for: WinSetOnTop Change a window's "Always On Top" attribute.
int	WinSetState(java.lang.String szTitle, java.lang.String szText, int nFlag) Documentation for: WinSetState Shows, hides, minimizes, maximizes, or restores a window.
int	WinSetTitle(java.lang.String szTitle, java.lang.String szText, java.lang.String szNewTitle) Documentation for: WinSetTitle Changes the title of a specified window.
int	WinSetTrans(java.lang.String szTitle, java.lang.String szText, int nTrans) Documentation for: WinSetTrans Sets the transparency of a window.
int	WinWait(java.lang.String szTitle, java.lang.String szText, int nTimeout) Documentation for: WinWait This function will pause until the specified window exists (or the function times out).
int	WinWaitActive(java.lang.String szTitle, java.lang.String szText, int nTimeout) Documentation for: WinWaitActive This function will pause until the specified window is active (or the function times out).
int	WinWaitClose(java.lang.String szTitle, java.lang.String szText, int nTimeout) Documentation for: WinWaitClose This function will pause until the specified window doesn't exist (or the function times out).
int	WinWaitNotActive(java.lang.String szTitle, java.lang.String szText, int nTimeout) Documentation for: WinWaitNotActive This function will pause until the specified window is not active (or the function times out).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoIt3

public AutoIt3()

Method Detail

Init

public void Init()

Documentation for: Init Resets AutoIt to defaults (window delays, key delays, etc.). This function is called automatically when the DLL is loaded.

BlockInput

public void BlockInput(int nToggle)

Documentation for: BlockInput Will prevent any user input via the mouse or keyboard. This function will have different effects depending on the operating system used:. Operating System "BlockInput" Results
Windows 95 No effect.
Windows 98 User input is blocked but AutoIt is also unable to simulate input.
Windows NT 4 (Without ServicePack 6) No effect.
Windows NT 4 (With ServicePack 6) User input is blocked and AutoIt can simulate input.
Windows 2000 User input is blocked and AutoIt can simulate input.

Parameters:

nToggle - This should be set to 1 to block input, and 0 to enable input.

CDTray

public void CDTray(java.lang.String szDrive,
                   java.lang.String szAction)

Documentation for: CDTray Controls CD tray of a local system.

Parameters:

szDrive - Accept drive letter (example D:)

szAction - Accepts "open" or "close"

ClipGet

public void ClipGet(AutoIt3.ByReferenceString szClip,
                    int nBufSize)

Documentation for: ClipGet Allows you to get text from the clipboard. A maximum of 4096 characters of text can be received; ensure that the text buffer you pass is at least this large.

Parameters:

szClip - A pointer to a string buffer that will receive the text from the clipboard.

nBufSize -

ClipPut

public void ClipPut(java.lang.String szClip)

Documentation for: ClipPut Allows you to get text from the clipboard. A maximum of 4096 characters of text can be received; ensure that the text buffer you pass is at least this large.

Parameters:

szClip - A pointer to a string buffer that contains the text you want to send.

ControlClick

public int ControlClick(java.lang.String szTitle,
                        java.lang.String szText,
                        java.lang.String szControl,
                        java.lang.String szButton,
                        int nNumClicks)

Documentation for: ControlClick Sends a mouse click command to a given control.

Parameters:

szTitle - This is the title of window to access

szText - This is the text of the window to access

szControl - The control to interact with

szButton - This is optional, the button to click: left, right, or middle. Default is left

nNumClicks - This is optional, the number of times to click the button. Default is 1

ControlCommand

public void ControlCommand(java.lang.String szTitle,
                           java.lang.String szText,
                           java.lang.String szControl,
                           java.lang.String szCommand,
                           java.lang.String szExtra,
                           AutoIt3.ByReferenceString szResult,
                           int nBufSize)

Documentation for: ControlCommand Sends a command to a control.

Parameters:

szTitle - The title of the window to access.

szText - The text of the window to access.

szControl - The control to interact with.

szCommand - The command to send to the control.

szExtra - Additional parameter required by some commands; use "" if parameter is not required.

szResult -

nBufSize -

ControlListView

public void ControlListView(java.lang.String szTitle,
                            java.lang.String szText,
                            java.lang.String szControl,
                            java.lang.String szCommand,
                            java.lang.String szExtra1,
                            java.lang.String szExtra2,
                            AutoIt3.ByReferenceString szResult,
                            long nBufSize)

Documentation for: ControlListView Sends a command to a ListView32 control.

Parameters:

szTitle - The title of the window to access.

szText - The text of the window to access.

szControl - The control to interact with.

szCommand - The command to send to the control. http://www.autoitscript.com/autoit3/docs/functions/ControlListView.htm

szExtra1 - [optional] Additional parameter required by some commands.

szExtra2 - [optional] Additional parameter required by some commands.

szResult -

nBufSize -

ControlDisable

public int ControlDisable(java.lang.String szTitle,
                          java.lang.String szText,
                          java.lang.String szControl)

Documentation for: ControlDisable Disables or "grays-out" a control.

Parameters:

szTitle - The title of the window to access.

szText - The text of the window to access.

szControl - The control to interact with.

ControlEnable

public int ControlEnable(java.lang.String szTitle,
                         java.lang.String szText,
                         java.lang.String szControl)

Documentation for: ControlEnable

Parameters:

szTitle - The title of the window to access.

szText - The text of the window to access.

szControl - The control to interact with.

ControlFocus

public int ControlFocus(java.lang.String szTitle,
                        java.lang.String szText,
                        java.lang.String szControl)

Documentation for: ControlFocus Sets input focus to a given control on a window.

Parameters:

szTitle - Title of window to check.

szText - Text from window to check.

szControl - The control to interact with.

ControlGetFocus

public void ControlGetFocus(java.lang.String szTitle,
                            java.lang.String szText,
                            AutoIt3.ByReferenceString szControlWithFocus,
                            int nBufSize)

Documentation for: ControlGetFocus Returns the ControlRef# of the control that has keyboard focus within a specified window.

Parameters:

szTitle - Title of window to check.

szText - [optional] Text from window to check.

szControlWithFocus - The control with the focus

nBufSize - Buffer

ControlGetHandle

public void ControlGetHandle(java.lang.String szTitle,
                             java.lang.String szText,
                             java.lang.String szControl,
                             AutoIt3.ByReferenceString szRetText,
                             int nBufSize)

Documentation for: ControlGetHandle Retrieves the internal handle of a control.

Parameters:

szTitle - The title of the window to access.

szText - The text of the window to access.

szControl - The control to interact with.

szRetText - The return text from the function

nBufSize - Buffer

ControlGetPosX

public int ControlGetPosX(java.lang.String szTitle,
                          java.lang.String szText,
                          java.lang.String szControl)

Documentation for: ControlGetPosX Returns the X position of a window.

Parameters:

szTitle -

szText -

szControl -

ControlGetPosY

public int ControlGetPosY(java.lang.String szTitle,
                          java.lang.String szText,
                          java.lang.String szControl)

Documentation for: ControlGetPosY Returns the Y position of a window.

Parameters:

szTitle -

szText -

szControl -

ControlGetPosHeight

public int ControlGetPosHeight(java.lang.String szTitle,
                               java.lang.String szText,
                               java.lang.String szControl)

Documentation for: ControlGetPosHeight Returns the height of a window.

Parameters:

szTitle -

szText -

szControl -

ControlGetPosWidth

public int ControlGetPosWidth(java.lang.String szTitle,
                              java.lang.String szText,
                              java.lang.String szControl)

Documentation for: ControlGetPosWidth Returns the width of a window.

Parameters:

szTitle -

szText -

szControl -

ControlGetText

public void ControlGetText(java.lang.String szTitle,
                           java.lang.String szText,
                           java.lang.String szControl,
                           AutoIt3.ByReferenceString szControlText,
                           int nBufSize)

Documentation for: ControlGetText Retrieves text from a control.

Parameters:

szTitle - The title of the window to access.

szText - The text of the window to access.

szControl - The control to interact with.

szControlText - The text returning from the control

nBufSize - Buffer

ControlHide

public int ControlHide(java.lang.String szTitle,
                       java.lang.String szText,
                       java.lang.String szControl)

Documentation for: ControlHide Hides a control

Parameters:

szTitle - The title of the window to access.

szText - The text of the window to access.

szControl - The control to interact with.

ControlMove

public int ControlMove(java.lang.String szTitle,
                       java.lang.String szText,
                       java.lang.String szControl,
                       int nX,
                       int nY,
                       int nWidth,
                       int nHeight)

Documentation for: ControlMove Moves a control within a window.

Parameters:

szTitle - The title of the window to move.

szText - The text of the window to move.

szControl - The control to interact with.

nX - X coordinate to move to.

nY - Y coordinate to move to.

nWidth - Optional - New width of the window.

nHeight - Optional - New height of the window.

ControlSend

public int ControlSend(java.lang.String szTitle,
                       java.lang.String szText,
                       java.lang.String szControl,
                       java.lang.String szSendText,
                       int nMode)

Documentation for: ControlSend Sends a string of characters to a control.

Parameters:

szTitle - The title of the window to access.

szText - The text of the window to access.

szControl - The control to interact with.

szSendText - String of characters to send to the control.

nMode - Optional - Changes how "keys" is processed: flag = 0 (default), Text contains special characters like + to indicate SHIFT and {LEFT} to indicate left arrow. flag = 1, keys are sent raw.

ControlSetText

public int ControlSetText(java.lang.String szTitle,
                          java.lang.String szText,
                          java.lang.String szControl,
                          java.lang.String szControlText)

Documentation for: ControlSetText Sets text of a control.

Parameters:

szTitle - The title of the window to access.

szText - The text of the window to access.

szControl - The control to interact with.

szControlText - The new text to be set into the control.

ControlShow

public int ControlShow(java.lang.String szTitle,
                       java.lang.String szText,
                       java.lang.String szControl)

Documentation for: ControlShow Shows a control that was hidden.

Parameters:

szTitle - The title of the window to access.

szText - The text of the window to access.

szControl - The control to interact with.

DriveMapAdd

public void DriveMapAdd(java.lang.String szDevice,
                        java.lang.String szShare,
                        int nFlags,
                        java.lang.String szUser,
                        java.lang.String szPwd,
                        AutoIt3.ByReferenceString szResult,
                        int nBufSize)

Documentation for: DriveMapAdd Maps a network drive.

Parameters:

szDevice - The device to map, for example "O:" or "LPT1:". If you pass a blank string for this parameter a connection is made but not mapped to a specific drive. If you specify "*" an unused drive letter will be automatically selected.

szShare - The remote share to connect to in the form "\\server\share".

nFlags - [optional] A combination of the following: 0 = default 1 = Persistant mapping 8 = Show authentication dialog if required

szUser - [optional] The username to use to connect. In the form "username" or "domain\\username".

szPwd - [optional] The password to use to connect.

szResult - The text of the window to access.

nBufSize - Buffer

DriveMapDel

public int DriveMapDel(java.lang.String szDevice)

Documentation for: DriveMapDel Disconnects a network drive.

Parameters:

szDevice - The device to disconnect, e.g. "O:" or "LPT1:".

DriveMapGet

public void DriveMapGet(java.lang.String szDevice,
                        AutoIt3.ByReferenceString szMapping,
                        int nBufSize)

Documentation for: DriveMapGet Retreives the details of a mapped drive.

Parameters:

szDevice - The device (drive or printer) letter to query. Eg. "O:" or "LPT1:"

szMapping -

nBufSize - Buffer

IniDelete

public int IniDelete(java.lang.String szFilename,
                     java.lang.String szSection,
                     java.lang.String szKey)

Documentation for: IniDelete Deletes a value from a standard format .ini file.

Parameters:

szFilename -

szSection -

szKey -

IniRead

public void IniRead(java.lang.String szFileName,
                    java.lang.String szSection,
                    java.lang.String szKey,
                    java.lang.String szDefault,
                    AutoIt3.ByReferenceString szValue,
                    int nBufSize)

Documentation for: IniRead Reads a value from a standard format .ini file.

Parameters:

szFileName - The filename of the .ini file.

szSection - The section name in the .ini file.

szKey - The key name in the in the .ini file.

szDefault - The default value to return if the requested key is not found.

szValue - The returned value from the ini file.

nBufSize -

IniWrite

public int IniWrite(java.lang.String szFileName,
                    java.lang.String szSection,
                    java.lang.String szKey,
                    java.lang.String szValue)

Documentation for: IniWrite Writes a value to a standard format .ini file.

Parameters:

szFileName - The filename of the .ini file.

szSection - The section name in the .ini file.

szKey - The key name in the in the .ini file.

szValue - The value to write/change.

IsAdmin

public int IsAdmin()

Documentation for: IsAdmin Checks if the current user has administrator privileges.

MouseClick

public int MouseClick(java.lang.String szButton,
                      int nX,
                      int nY,
                      int nClicks,
                      int nSpeed)

Documentation for: MouseClick Perform a mouse click operation.

Parameters:

szButton - The button to click: "left", "right", "middle", "main", "menu", "primary", "secondary".

nX - The x/y coordinates to move the mouse to. If no x and y coords are given, the current position is used.

nY - The x/y coordinates to move the mouse to. If no x and y coords are given, the current position is used.

nClicks - The number of times to click the mouse. Default is 1.

nSpeed - the speed to move the mouse in the range 1 (fastest) to 100 (slowest). A speed of 0 will move the mouse instantly. Default speed is 10.

MouseClickDrag

public int MouseClickDrag(java.lang.String szButton,
                          int nX1,
                          int nY1,
                          int nX2,
                          int nY2,
                          int nSpeed)

Documentation for: MouseClickDrag Perform a mouse click and drag operation.

Parameters:

szButton - The button to click: "left", "right", "middle", "main", "menu", "primary", "secondary".

nX1 - The x/y coords to start the drag operation from.

nY1 - The x/y coords to start the drag operation from.

nX2 - The x/y coords to stop the drag operation from.

nY2 - The x/y coords to stop the drag operation from.

nSpeed - [optional] the speed to move the mouse in the range 1 (fastest) to 100 (slowest). A speed of 0 will move the mouse instantly. Default speed is 10.

MouseDown

public void MouseDown(java.lang.String szButton)

Documentation for: MouseDown Perform a mouse down event at the current mouse position.

Parameters:

szButton - The button to click: "left", "right", "middle", "main", "menu", "primary", "secondary".

MouseGetCursor

public int MouseGetCursor()

Documentation for: MouseGetCursor Returns a cursor ID Number: 0 = UNKNOWN (this includes pointing and grabbing hand icons) 1 = APPSTARTING 2 = ARROW 3 = CROSS 4 = HELP 5 = IBEAM 6 = ICON 7 = NO 8 = SIZE 9 = SIZEALL 10 = SIZENESW 11 = SIZENS 12 = SIZENWSE 13 = SIZEWE 14 = UPARROW 15 = WAIT

MouseGetPosX

public int MouseGetPosX()

Documentation for: MouseGetPosX Gets the X coordinate of the mouse pointer. The X and Y co-ordinates are relative to the currently active window. Run the full version of AutoIt in reveal mode to determine the required co-ordinates of a window.

MouseGetPosY

public int MouseGetPosY()

Documentation for: MouseGetPosY Gets the Y coordinate of the mouse pointer. The X and Y co-ordinates are relative to the currently active window. Run the full version of AutoIt in reveal mode to determine the required co-ordinates of a window.

MouseMove

public int MouseMove(int nX,
                     int nY,
                     int nSpeed)

Documentation for: MouseMove Moves the mouse pointer to the specified coordinates. The X and Y co-ordinates are relative to the currently active window. Run the full version of AutoIt in reveal mode to determine the required co-ordinates of a window. @param nX X coordinate.

Parameters:

nY - Y coordinate.

nSpeed - Speed of movement

MouseUp

public void MouseUp(java.lang.String szButton)

Documentation for: MouseUp Perform a mouse up event at the current mouse position.

Parameters:

szButton - The button to click: "left", "right", "middle", "main", "menu", "primary", "secondary".

MouseWheel

public void MouseWheel(java.lang.String szDirection,
                       int nClicks)

Documentation for: MouseWheel Moves the mouse wheel up or down. NT/2000/XP ONLY.

Parameters:

szDirection - "up" or "down"

nClicks - [optional] The number of times to move the wheel. Default is 1.

Opt

public int Opt(java.lang.String szOption,
               int nValue)

Documentation for: Opt This option will set Function options in AutoIT.

Parameters:

szOption -

nValue -

PixelChecksum

public int PixelChecksum(int nLeft,
                         int nTop,
                         int nRight,
                         int nBottom,
                         int nStep)

Documentation for: PixelChecksum Generates a checksum for a region of pixels.

Parameters:

nLeft - left coordinate of rectangle.

nTop - top coordinate of rectangle.

nRight - right coordinate of rectangle.

nBottom - bottom coordinate of rectangle.

nStep - [optional] Instead of checksumming each pixel use a value larger than 1 to skip pixels (for speed). E.g. A value of 2 will only check every other pixel. Default is 1.

PixelGetColor

public int PixelGetColor(int nX,
                         int nY)

Documentation for: PixelGetColor Returns a pixel color according to x,y pixel coordinates.

Parameters:

nX - x coordinate of pixel.

nY - y coordinate of pixel.

PixelSearch

public void PixelSearch(int nLeft,
                        int nTop,
                        int nRight,
                        int nBottom,
                        int nCol,
                        int nVar,
                        int nStep,
                        AutoIt3.ByReferenceString szResult,
                        int nBufSize)

Documentation for: PixelSearch Searches a rectangle of pixels for the pixel color provided.

Parameters:

nLeft - left coordinate of rectangle.

nTop - top coordinate of rectangle.

nRight - right coordinate of rectangle.

nBottom - bottom coordinate of rectangle.

nCol - Colour value of pixel to find (in decimal or hex).

nVar - [optional] A number between 0 and 255 to indicate the allowed number of shades of variation of the red, green, and blue components of the colour. Default is 0 (exact match).

nStep - [optional] Instead of searching each pixel use a value larger than 1 to skip pixels (for speed). E.g. A value of 2 will only check every other pixel. Default is 1.

szResult - The output of the function (color)

nBufSize - Buffer

ProcessClose

public int ProcessClose(java.lang.String szProcess)

Documentation for: ProcessClose Terminates a named process.

Parameters:

szProcess - The name of the process

ProcessExists

public int ProcessExists(java.lang.String szProcess)

Documentation for: ProcessExists Checks to see if a specified process exists.

Parameters:

szProcess - Name of the process

ProcessSetPriority

public int ProcessSetPriority(java.lang.String szProcess,
                              int nPriority)

Documentation for: ProcessSetPriority Changes the priority of a process

Parameters:

szProcess - The name or PID of the process to check.

nPriority - A flag which determines what priority to set 0 - Idle/Low 1 - Below Normal (Not supported on Windows 95/98/ME) 2 - Normal 3 - Above Normal (Not supported on Windows 95/98/ME) 4 - High 5 - Realtime (Use with caution, may make the system unstable)

ProcessWait

public int ProcessWait(java.lang.String szProcess,
                       int nTimeout)

Documentation for: ProcessWait Pauses script execution until a given process exists.

Parameters:

szProcess - The name of the process to check.

nTimeout - [optional] Specifies how long to wait (default is to wait indefinitely).

ProcessWaitClose

public int ProcessWaitClose(java.lang.String szProcess,
                            int nTimeout)

Documentation for: ProcessWaitClose Pauses script execution until a given process does not exist.

Parameters:

szProcess - The name of the process to close.

nTimeout - [optional] Specifies how long to wait (default is to wait indefinitely).

RegDeleteKey

public int RegDeleteKey(java.lang.String szKeyName)

Documentation for: RegDeleteKey Deletes a key or value from the registry.

Parameters:

szKeyName - The registry key to delete.

RegDeleteVal

public int RegDeleteVal(java.lang.String szKeyName,
                        java.lang.String szValuename)

Documentation for: RegDeleteVal Deletes a key or value from the registry.

Parameters:

szKeyName - The registry key to delete.

szValuename - The valuename to delete.

RegEnumKey

public void RegEnumKey(java.lang.String szKeyName,
                       int nInstance,
                       AutoIt3.ByReferenceString szResult,
                       int nBufSize)

Documentation for: RegEnumKey Reads the name of a subkey according to it's instance.

Parameters:

szKeyName - The registry key to read.

nInstance - The 1-based key instance to retrieve

szResult - The result of the function

nBufSize - Buffer

RegEnumVal

public void RegEnumVal(java.lang.String szKeyName,
                       int nInstance,
                       AutoIt3.ByReferenceString szResult,
                       int nBufSize)

Documentation for: RegEnumVal Reads the name of a value according to it's instance.

Parameters:

szKeyName - The registry key to read.

nInstance - The 1-based key instance to retrieve

szResult - The result of the function

nBufSize - Buffer

RegRead

public void RegRead(java.lang.String szKeyName,
                    java.lang.String szValuename,
                    AutoIt3.ByReferenceString szRetText,
                    int nBufSize)

Documentation for: RegRead Reads a value from the registry.

Parameters:

szKeyName - The registry key to read.

szValuename - The value to read.

szRetText - The return text of the function

nBufSize - Buffer

RegWrite

public int RegWrite(java.lang.String szKeyName,
                    java.lang.String szValueName,
                    java.lang.String szType,
                    java.lang.String szValue)

Documentation for: RegWrite Creates a key or value in the registry.

Parameters:

szKeyName - The registry key to write to. If no other parameters are specified this key will simply be created.

szValueName - [optional] The valuename to write to.

szType - [optional] Type of key to write: "REG_SZ", "REG_MULTI_SZ", "REG_EXPAND_SZ", "REG_DWORD", or "REG_BINARY".

szValue - [optional] The value to write.

Run

public int Run(java.lang.String szRun,
               java.lang.String szDir,
               int nShowFlags)

Documentation for: Run Runs an external program.

Parameters:

szRun - The full name of the executable (EXE, BAT, COM, or PIF) to run.

szDir - [optional] The working directory.

nShowFlags - [optional] The "show" flag of the executed program:

RunAsSet

public int RunAsSet(java.lang.String szUser,
                    java.lang.String szDomain,
                    java.lang.String szPassword,
                    int nOptions)

Documentation for: RunAsSet Initialise a set of user credentials to use during Run and RunWait operations. 2000/XP or later ONLY.

Parameters:

szUser - [optional] The user name to use.

szDomain - [optional] The domain name to use.

szPassword - [optional] The password to use.

nOptions - [optional] 0 = do not load the user profile, 1 = (default) load the user profile, 2 = use for net credentials only

RunWait

public int RunWait(java.lang.String szRun,
                   java.lang.String szDir,
                   int nShowFlags)

Documentation for: RunWait Runs an external program and pauses script execution until the program finishes.

Parameters:

szRun - The name of the executable (EXE, BAT, COM, PIF) to run.

szDir - [optional] The working directory.

nShowFlags - [optional] The "show" flag of the executed program:

Send

public void Send(java.lang.String szSentText,
                 int nMode)

Documentation for: Send Set an error message. The Error subroutine will add the string value passed by the calling program to the Error File and then terminate the calling program. The "Send" command syntax is similar to that of ScriptIt and the Visual Basic "SendKeys" command. Characters are sent as written with the exception of the following characters: '!' This tells AutoIt to send an ALT keystroke, therefore Send "This is text!a" would send the keys "This is text" and then press "ALT+a". N.B. Some programs are very choosy about capital letters and ALT keys, i.e. "!A" is different to "!a". The first says ALT+SHIFT+A, the second is ALT+a. If in doubt, use lowercase! '+' This tells AutoIt to send a SHIFT keystroke, therefore Send "Hell+o" would send the text "HellO". Send "!+a" would send "ALT+SHIFT+a". '^' This tells AutoIt to send a CONTROL keystroke, therefore Send "^!a" would send "CTRL+ALT+a". N.B. Some programs are very choosy about capital letters and CTRL keys, i.e. "^A" is different to "^a". The first says CTRL+SHIFT+A, the second is CTRL+a. If in doubt, use lowercase! '#' The hash is used as a key delimiter to make a line easier to read. i.e. Send "H#e#l#l#o" is the same as Send "Hello". Certain special keys can be sent and should be enclosed in braces:

Parameters:

szSentText - A string pointer to the set of keystrokes to send.

nMode - The option in which the text should be sent (optional). 0 (default) contains special characters. 1 text is sent raw.

Shutdown

public int Shutdown(int nFlag)

Documentation for: Shutdown This function can perform various types of shutdown on all Windows operating systems. The value of nFlag can be a combination of the flags below: Function
Log off the current user 0
Shutdown the workstation 1
Reboot the workstation 2
Force closing of applications (may lose unsaved work) 4
Shutdown and power off (if supported) 8 i.e. To shutdown and reboot, the value of nFlag would be 3.

Parameters:

nFlag - A combination of the flags given in the remarks section.

Sleep

public void Sleep(int nMilliseconds)

Documentation for: Sleep This function simply pauses for an amount of time.

Parameters:

nMilliseconds - The amount of time to sleep in milliseconds. (Note: 1000 milliseconds = 1 second)

StatusbarGetText

public void StatusbarGetText(java.lang.String szTitle,
                             java.lang.String szText,
                             int nPart,
                             AutoIt3.ByReferenceString szStatusText,
                             int nBufSize)

Documentation for: StatusbarGetText Retrieves the text from a standard status bar control.

Parameters:

szTitle - The title of the window to check.

szText - [optional] The text of the window to check.

nPart - [optional] The "part" number of the status bar to read - the default is 1. 1 is the first possible part and usually the one that contains the useful messages like "Ready" "Loading...", etc.

szStatusText - Return text from the function

nBufSize - Buffer

ToolTip

public void ToolTip(java.lang.String szTip,
                    int nX,
                    int nY)

Documentation for: ToolTip Creates a tooltip anywhere on the screen.

Parameters:

szTip - The text of the tooltip. (An empty string clears a displaying tooltip)

nX - [optional] The x,y position of the tooltip.

nY - [optional] The x,y position of the tooltip.

WinActivate

public void WinActivate(java.lang.String szTitle,
                        java.lang.String szText)

Documentation for: WinActivate This function will activate a specified window.

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

WinActive

public int WinActive(java.lang.String szTitle,
                     java.lang.String szText)

Documentation for: WinActive Checks if a given window is currently active. Returns 1 if the given window was active, otherwise it returns 0.

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

WinClose

public int WinClose(java.lang.String szTitle,
                    java.lang.String szText)

Documentation for: WinClose This function will close a specified window

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

WinExists

public int WinExists(java.lang.String szTitle,
                     java.lang.String szText)

Documentation for: WinExists Checks if a given window current exists (in any state). Returns 1 if the given window exists (regardless of its state), otherwise it returns 0.

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

WinGetCaretPosX

public int WinGetCaretPosX()

Documentation for: WinGetCaretPosX Returns a 2-element array containing the following information: array[0] = X coordinate

WinGetCaretPosY

public int WinGetCaretPosY()

Documentation for: WinGetCaretPosY Returns a 2-element array containing the following information: array[1] = Y coordinate

WinGetClassList

public void WinGetClassList(java.lang.String szTitle,
                            java.lang.String szText,
                            AutoIt3.ByReferenceString szRetText,
                            int nBufSize)

Documentation for: WinGetClassList Retrieves the classes from a window.

Parameters:

szTitle - The title of the window to read.

szText - [optional] The text of the window to read.

szRetText - Return text from the function

nBufSize - Buffer

WinGetClientSizeHeight

public int WinGetClientSizeHeight(java.lang.String szTitle,
                                  java.lang.String szText)

Documentation for: WinGetClientSizeHeight Retrieves the size of a given window's client area.

Parameters:

szTitle - The title of the window to read.

szText - [optional] The text of the window to read.

WinGetClientSizeWidth

public int WinGetClientSizeWidth(java.lang.String szTitle,
                                 java.lang.String szText)

Documentation for: WinGetClientSizeWidth Retrieves the size of a given window's client area.

Parameters:

szTitle - The title of the window to read.

szText - The text of the window to read.

WinGetHandle

public void WinGetHandle(java.lang.String szTitle,
                         java.lang.String szText,
                         AutoIt3.ByReferenceString szRetText,
                         int nBufSize)

Documentation for: WinGetHandle A string pointer to receive the window title.

Parameters:

szTitle - A string pointer to receive the window title.

szText - The text of the window to read

szRetText -

nBufSize - Buffer

WinGetPosX

public int WinGetPosX(java.lang.String szTitle,
                      java.lang.String szText)

Documentation for: WinGetPosX Retrieves the position and size of a given window.

Parameters:

szTitle - The title of the window to read.

szText - [optional] The text of the window to read.

WinGetPosY

public int WinGetPosY(java.lang.String szTitle,
                      java.lang.String szText)

Documentation for: WinGetPosY Retrieves the position and size of a given window.

Parameters:

szTitle - The title of the window to read.

szText - [optional] The text of the window to read.

WinGetPosHeight

public int WinGetPosHeight(java.lang.String szTitle,
                           java.lang.String szText)

Documentation for: WinGetPosHeight Retrieves the height of a given window.

Parameters:

szTitle - The title of the window to read.

szText - [optional] The text of the window to read.

WinGetPosWidth

public int WinGetPosWidth(java.lang.String szTitle,
                          java.lang.String szText)

Documentation for: WinGetPosWidth Retrieves the width of a given window.

Parameters:

szTitle - The title of the window to read.

szText - [optional] The text of the window to read.

WinGetProcess

public void WinGetProcess(java.lang.String szTitle,
                          java.lang.String szText,
                          AutoIt3.ByReferenceString szRetText,
                          int nBufSize)

Documentation for: WinGetProcess Retrieves the Process ID (PID) associated with a window

Parameters:

szTitle - The title of the window to read.

szText - [optional] The text of the window to read.

szRetText - The return text of the function.

nBufSize - Buffer

WinGetState

public int WinGetState(java.lang.String szTitle,
                       java.lang.String szText)

Documentation for: WinGetState Returns a value indicating the state of the window. Multiple values are added together so use BitAND() to examine the part you are interested in: 1 = Window exists 2 = Window is visible 4 = Windows is enabled 8 = Window is active 16 = Window is minimized 32 = Windows is maximized

Parameters:

szTitle - The title of the window

szText - The text of the window.

WinGetText

public void WinGetText(java.lang.String szTitle,
                       java.lang.String szText,
                       AutoIt3.ByReferenceString szRetText,
                       int nBufSize)

Documentation for: WinGetText Retrieves the text from a window.

Parameters:

szTitle - Title of the window.

szText - Text of the window.

szRetText - Return text of the function

nBufSize - Buffer.

WinGetTitle

public void WinGetTitle(java.lang.String szTitle,
                        java.lang.String szText,
                        AutoIt3.ByReferenceString szRetText,
                        int nBufSize)

Documentation for: WinGetTitle Retrieves the title from a window.

Parameters:

szTitle - Title of the window.

szText - Text of the window.

szRetText - Return text of the function

nBufSize - Buffer.

WinKill

public int WinKill(java.lang.String szTitle,
                   java.lang.String szText)

Documentation for: WinKill This function will forceably close a specified window.

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

WinMenuSelectItem

public int WinMenuSelectItem(java.lang.String szTitle,
                             java.lang.String szText,
                             java.lang.String szItem1,
                             java.lang.String szItem2,
                             java.lang.String szItem3,
                             java.lang.String szItem4,
                             java.lang.String szItem5,
                             java.lang.String szItem6,
                             java.lang.String szItem7,
                             java.lang.String szItem8)

Documentation for: WinMenuSelectItem Invokes a menu item of a window.

Parameters:

szTitle - The title of the window to read.

szText - The text of the window to read.

szItem1 - Text of Menu Item

szItem2 - [optional] Text of SubMenu item

szItem3 - [optional] Text of SubMenu item

szItem4 - [optional] Text of SubMenu item

szItem5 - [optional] Text of SubMenu item

szItem6 - [optional] Text of SubMenu item

szItem7 - [optional] Text of SubMenu item

szItem8 - [optional] Text of SubMenu item

WinMinimizeAll

public void WinMinimizeAll()

Documentation for: WinMinimizeAll This function will minimize all windows.

WinMinimizeAllUndo

public void WinMinimizeAllUndo()

Documentation for: WinMinimizeAllUndo This function will undo a previous WinMinimizeAll call.

WinMove

public int WinMove(java.lang.String szTitle,
                   java.lang.String szText,
                   int nX,
                   int nY,
                   int nWidth,
                   int nHeight)

Documentation for: WinMove Use this function to move/resize a specified window.

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

nX - X coordinate.

nY - Y coordinate.

nWidth - New width of the window (use -1 to leave the size alone)

nHeight - New height of the window (use -1 to leave the size alone)

WinSetOnTop

public int WinSetOnTop(java.lang.String szTitle,
                       java.lang.String szText,
                       int nFlag)

Documentation for: WinSetOnTop Change a window's "Always On Top" attribute.

Parameters:

szTitle - The title of the window to affect.

szText - The text of the window to affect.

nFlag - Determines whether the window should have the "TOPMOST" flag set. 1=set on top flag, 0 = remove on top flag

WinSetState

public int WinSetState(java.lang.String szTitle,
                       java.lang.String szText,
                       int nFlag)

Documentation for: WinSetState Shows, hides, minimizes, maximizes, or restores a window.

Parameters:

szTitle - The title of the window to affect.

szText - The text of the window to affect.

nFlag - The "show" flag of the executed program:

WinSetTitle

public int WinSetTitle(java.lang.String szTitle,
                       java.lang.String szText,
                       java.lang.String szNewTitle)

Documentation for: WinSetTitle Changes the title of a specified window.

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

szNewTitle - A string pointer to the text of the new window title.

WinSetTrans

public int WinSetTrans(java.lang.String szTitle,
                       java.lang.String szText,
                       int nTrans)

Documentation for: WinSetTrans Sets the transparency of a window. (Windows 2000/XP or later)

Parameters:

szTitle - The title of the window to change.

szText - The text of the window to change.

nTrans - A number in the range 0 - 255. The larger the number, the more transparent the window will become.

WinWait

public int WinWait(java.lang.String szTitle,
                   java.lang.String szText,
                   int nTimeout)

Documentation for: WinWait This function will pause until the specified window exists (or the function times out).

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

nTimeout - Specifies the number of seconds to wait for. Use the value 0 to wait indefinitely.

WinWaitActive

public int WinWaitActive(java.lang.String szTitle,
                         java.lang.String szText,
                         int nTimeout)

Documentation for: WinWaitActive This function will pause until the specified window is active (or the function times out).

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

nTimeout - Specifies the number of seconds to wait for. Use the value 0 to wait indefinitely.

WinWaitClose

public int WinWaitClose(java.lang.String szTitle,
                        java.lang.String szText,
                        int nTimeout)

Documentation for: WinWaitClose This function will pause until the specified window doesn't exist (or the function times out).

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

nTimeout - Specifies the number of seconds to wait for. Use the value 0 to wait indefinitely.

WinWaitNotActive

public int WinWaitNotActive(java.lang.String szTitle,
                            java.lang.String szText,
                            int nTimeout)

Documentation for: WinWaitNotActive This function will pause until the specified window is not active (or the function times out).

Parameters:

szTitle - A string pointer to the title of the window to match.

szText - A string pointer to the text of the window to match.

nTimeout - Specifies the number of seconds to wait for. Use the value 0 to wait indefinitely.