x.x.x AutoIt API (AutoIt)

  AutoIt is a simple tool that can simulate key presses, 
  mouse movements and window commands (maximize, minimize, wait for, etc.) 
  in order to automate any windows based task (or even windowed DOS tasks).

Deprecated Function	Use Description
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 <br />Windows 95 No effect. <br />Windows 98 User input is blocked but AutoIt is also unable to simulate input. <br />Windows NT 4 (Without ServicePack 6) No effect. <br />Windows NT 4 (With ServicePack 6) User input is blocked and AutoIt can simulate input. <br />Windows 2000 User input is blocked and AutoIt can simulate input.
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.
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.
Close	Closes down AutoIt. This function is called automatically when the DLL is unloaded.
DetectHiddenText	Some programs use hidden text on windows this can cause problems when trying to script them. This command allows you to tell AutoIt whether or not to detect this hidden text. When you use the "/reveal" mode of the full AutoIt product, you will see all text, including hidden text.
IfWinActive	Checks if a given window is currently active. Returns 1 if the given window was active, otherwise it returns 0.
IfWinExist	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.
IniDelete	Deletes a specified value from a standard .INI file. <p>An INI file is taken to be a file of the following format: <pre> [SectionName] Value=Result </pre> The full path of the INI file must be given, however, it is acceptable to use something similar to ".\myfile.ini" to indicate a file in the current working directory. </p> See also IniRead, IniWrite
IniRead	Reads a specified value from a standard .INI file.
Init	Resets AutoIt to defaults (window delays, key delays, etc.). This function is called automatically when the DLL is loaded.
IniWrite	Write a specified value to a standard .INI file. <p>An INI file is taken to be a file of the following format: <pre> [SectionName] Value=Result </pre> The full path of the INI file must be given, however, it is acceptable to use something similar to ".\myfile.ini" to indicate a file in the current working directory. </p>
LeftClick	Simulates a mouse left-click at a given coordinate. 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. To perform a double-click, simply run the command twice :)
LeftClickDrag	Simulates a mouse left-click-drag operation. 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.
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	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	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.
RightClick	Simulates a mouse right-click at a given coordinate. 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. To perform a double-click, simply run the command twice :)
RightClickDrag	Simulates a mouse right-click-drag operation. 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.
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:
SetCapslockState	This command will correctly set the state of the CAPSLOCK key to either on or off.
SetKeyDelay	This functions will alter the amount of time that AutoIt pauses between each simulated keypress.
SetStoreCapslockMode	By default, at the start of a "Send" command AutoIt will store the state of the CAPSLOCK key; at the end of the "Send" command this status will be restored. Use this command to turn off this behaviour.
SetTitleMatchMode	This function will alter the way that AutoIt matches window titles in functions such as WinWait, IfWinActive, etc. <p>mode 1: In the szTitle string you specify the start of a window title to match. i.e. for the notepad.exe window (Untitled - Notepad), valid matches would be: Untitled", "Untitled -", "Unt" and "Untitled - Notepad".<p> <p>mode 2: In the szTitle string you can specify ANY substring of the window title you want to match. Again for the notepad.exe window valid matches would be: Untitled", "Untitled - Notepad", "Notepad", "No".<p>
SetWinDelay	This functions will alter the amount of time that AutoIt pauses after performing a WinWait-type function.
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 <br />Log off the current user 0 <br />Shutdown the workstation 1 <br />Reboot the workstation 2 <br />Force closing of applications (may lose unsaved work) 4 <br />Shutdown and power off (if supported) 8 i.e. To shutdown and reboot, the value of nFlag would be 3.
Sleep	This function simply pauses for an amount of time.
WinActivate	This function will activate a specified window.
WinClose	This function will close a specified window
WinGetActiveTitle	A string pointer to receive the window title.
WinHide	This function will hide a specified window.
WinKill	This function will forceably close a specified window.
WinMaximize	This function will maximize a specified window.
WinMinimize	This function will minimize a specified window.
WinMinimizeAll	This function will minimize all windows.
WinMinimizeAllUndo	This function will undo a previous WinMinimizeAll call.
WinMove	Use this function to move/resize a specified window.
WinRestore	This function will restore a window from a minimized state.
WinSetTitle	Changes the title of a specified window.
WinShow	This function will show a specified window previously hidden.
WinWait	This function will pause until the specified window exists (or the function times out).
WinWaitActive	This function will pause until the specified window is active (or the function times out).
WinWaitClose	This function will pause until the specified window doesn't exist (or the function times out).
WinWaitNotActive	This function will pause until the specified window is not active (or the function times out).

x.x.x.1 Function Close

Closes down AutoIt. This function is called automatically when the DLL is unloaded.

x.x.x.2 Function Init

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

x.x.x.3 Function 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.

Shutdown (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nFlag	int	integer*4	integer	int	value	input	A combination of the flags given in the remarks section.

x.x.x.4 Function Sleep

This function simply pauses for an amount of time.

Sleep (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nMilliseconds	int	integer*4	integer	int	value	input	The amount of time to sleep in milliseconds. (Note: 1000 milliseconds = 1 second)

x.x.x.5 Function 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.

BlockInput (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nToggle	int	integer*4	integer	int	value	input	This should be set to 1 to block input, and 0 to enable input.

x.x.x.6 Function LeftClick

Simulates a mouse left-click at a given coordinate. 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. To perform a double-click, simply run the command twice :)

LeftClick (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nX	int	integer*4	integer	int	value	input	X coordinate.
nY	int	integer*4	integer	int	value	input	Y coordinate.

x.x.x.7 Function LeftClickDrag

Simulates a mouse left-click-drag operation. 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.

LeftClickDrag (4 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nX1	int	integer*4	integer	int	value	input	X1 coordinate (from coordinate).
nY1	int	integer*4	integer	int	value	input	Y1 coordinate (from coordinate).
nX2	int	integer*4	integer	int	value	input	X2 coordinate (to coordinate).
nY2	int	integer*4	integer	int	value	input	Y2 coordinate (to coordinate).

x.x.x.8 Function 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.

MouseMove (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nX	int	integer*4	integer	int	value	input	X coordinate.
nY	int	integer*4	integer	int	value	input	Y coordinate.

x.x.x.9 Function 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.

Return value

C++	FORTRAN	VB	java
int	integer*4	integer	int

x.x.x.10 Function 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.

Return value

C++	FORTRAN	VB	java
int	integer*4	integer	int

x.x.x.11 Function RightClick

Simulates a mouse right-click at a given coordinate. 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. To perform a double-click, simply run the command twice :)

RightClick (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nX	int	integer*4	integer	int	value	input	X coordinate.
nY	int	integer*4	integer	int	value	input	Y coordinate.

x.x.x.12 Function RightClickDrag

Simulates a mouse right-click-drag operation. 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.

RightClickDrag (4 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nX1	int	integer*4	integer	int	value	input	X1 coordinate (from coordinate).
nY1	int	integer*4	integer	int	value	input	Y1 coordinate (from coordinate).
nX2	int	integer*4	integer	int	value	input	X2 coordinate (to coordinate).
nY2	int	integer*4	integer	int	value	input	Y2 coordinate (to coordinate).

x.x.x.13 Function 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:

Send (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szLine	char *	character*4096	String	String	value	input	A string pointer to the set of keystrokes to send.

x.x.x.14 Function SetCapslockState

This command will correctly set the state of the CAPSLOCK key to either on or off.

SetCapslockState (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nToggle	int	integer*4	integer	int	value	input	This should be set to 1 to set capslock to ON, and 0 to set capslock to OFF.

x.x.x.15 Function SetKeyDelay

This functions will alter the amount of time that AutoIt pauses between each simulated keypress.

SetKeyDelay (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nDelay	int	integer*4	integer	int	value	input	This functions will alter the amount of time that AutoIt pauses between each simulated keypress.

x.x.x.16 Function SetStoreCapslockMode

By default, at the start of a "Send" command AutoIt will store the state of the CAPSLOCK key; at the end of the "Send" command this status will be restored. Use this command to turn off this behaviour.

SetStoreCapslockMode (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nToggle	int	integer*4	integer	int	value	input	This should be set to 1 to store/restore the capslock at the start/end of a send command, and 0 to ignore capslock state. (Default is 1).

x.x.x.17 Function DetectHiddenText

Some programs use hidden text on windows this can cause problems when trying to script them. This command allows you to tell AutoIt whether or not to detect this hidden text. When you use the "/reveal" mode of the full AutoIt product, you will see all text, including hidden text.

DetectHiddenText (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nToggle	int	integer*4	integer	int	value	input	This should be set to 1 to enable hidden text detection, and 0 to disable. (Default is 0)

x.x.x.18 Function IfWinActive

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

Return value

C++	FORTRAN	VB	java
int	integer*4	integer	int

IfWinActive (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.

x.x.x.19 Function IfWinExist

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.

Return value

C++	FORTRAN	VB	java
int	integer*4	integer	int

IfWinExist (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.

x.x.x.20 Function SetTitleMatchMode

This function will alter the way that AutoIt matches window titles in functions such as WinWait, IfWinActive, etc. mode 1: In the szTitle string you specify the start of a window title to match. i.e. for the notepad.exe window (Untitled - Notepad), valid matches would be: Untitled", "Untitled -", "Unt" and "Untitled - Notepad". mode 2: In the szTitle string you can specify ANY substring of the window title you want to match. Again for the notepad.exe window valid matches would be: Untitled", "Untitled - Notepad", "Notepad", "No".

SetTitleMatchMode (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nMode	int	integer*4	integer	int	value	input	The mode of title matching to use -- see the remarks. Valid modes are 1 and 2. (Default is 1).

x.x.x.21 Function SetWinDelay

This functions will alter the amount of time that AutoIt pauses after performing a WinWait-type function.

SetWinDelay (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
nDelay	int	integer*4	integer	int	value	input	The value in milliseconds pause after a WinWait-related function. (Default 500ms).

x.x.x.22 Function WinActivate

This function will activate a specified window.

WinActivate (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.

x.x.x.23 Function WinClose

This function will close a specified window

WinClose (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.

x.x.x.24 Function WinGetActiveTitle

A string pointer to receive the window title.

WinGetActiveTitle (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	output	A string pointer to receive the window title.

x.x.x.25 Function WinHide

This function will hide a specified window.

WinHide (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.

x.x.x.26 Function WinKill

This function will forceably close a specified window.

WinKill (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.

x.x.x.27 Function WinMaximize

This function will maximize a specified window.

WinMaximize (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.

x.x.x.28 Function WinMinimize

This function will minimize a specified window.

WinMinimize (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.

x.x.x.29 Function WinMinimizeAll

This function will minimize all windows.

x.x.x.30 Function WinMinimizeAllUndo

This function will undo a previous WinMinimizeAll call.

x.x.x.31 Function WinMove

Use this function to move/resize a specified window.

WinMove (6 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.
nX	int	integer*4	integer	int	value	input	X coordinate.
nY	int	integer*4	integer	int	value	input	Y coordinate.
nWidth	int	integer*4	integer	int	value	input	New width of the window (use -1 to leave the size alone)
nHeight	int	integer*4	integer	int	value	input	New height of the window (use -1 to leave the size alone)

x.x.x.32 Function WinRestore

This function will restore a window from a minimized state.

WinRestore (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.

x.x.x.33 Function WinSetTitle

Changes the title of a specified window.

WinSetTitle (3 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.
szNewTitle	char *	character*4096	String	String	value	input	A string pointer to the text of the new window title.

x.x.x.34 Function WinShow

This function will show a specified window previously hidden.

WinShow (2 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.

x.x.x.35 Function WinWait

This function will pause until the specified window exists (or the function times out).

Return value

C++	FORTRAN	VB	java
int	integer*4	integer	int

WinWait (3 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.
nTimeout	int	integer*4	integer	int	value	input	Specifies the number of seconds to wait for. Use the value 0 to wait indefinitely.

x.x.x.36 Function WinWaitActive

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

Return value

C++	FORTRAN	VB	java
int	integer*4	integer	int

WinWaitActive (3 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.
nTimeout	int	integer*4	integer	int	value	input	Specifies the number of seconds to wait for. Use the value 0 to wait indefinitely.

x.x.x.37 Function WinWaitNotActive

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

Return value

C++	FORTRAN	VB	java
int	integer*4	integer	int

WinWaitNotActive (3 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.
nTimeout	int	integer*4	integer	int	value	input	Specifies the number of seconds to wait for. Use the value 0 to wait indefinitely.

x.x.x.38 Function WinWaitClose

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

Return value

C++	FORTRAN	VB	java
int	integer*4	integer	int

WinWaitClose (3 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szTitle	char *	character*4096	String	String	value	input	A string pointer to the title of the window to match.
szText	char *	character*4096	String	String	value	input	A string pointer to the text of the window to match.
nTimeout	int	integer*4	integer	int	value	input	Specifies the number of seconds to wait for. Use the value 0 to wait indefinitely.

x.x.x.39 Function IniDelete

Deletes a specified value from a standard .INI file. An INI file is taken to be a file of the following format: <pre> [SectionName] Value=Result </pre> The full path of the INI file must be given, however, it is acceptable to use something similar to ".\myfile.ini" to indicate a file in the current working directory. See also IniRead, IniWrite

IniDelete (3 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szFile	char *	character*4096	String	String	value	input	A string pointer to the filename of the .INI file.
szSection	char *	character*4096	String	String	value	input	A string pointer to the required section of the .INI file.
szValue	char *	character*4096	String	String	value	input	A string pointer to the value to delete.

x.x.x.40 Function IniRead

Reads a specified value from a standard .INI file.

IniRead (4 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szFile	char *	character*4096	String	String	value	input	A string pointer to the filename of the .INI file.
szSection	char *	character*4096	String	String	value	input	A string pointer to the required section of the .INI file.
szValue	char *	character*4096	String	String	value	input	A string pointer to the value to read.
szResult	char *	character*4096	String	String	value	output	A string pointer to receive the result.

x.x.x.41 Function IniWrite

Write a specified value to a standard .INI file. An INI file is taken to be a file of the following format: <pre> [SectionName] Value=Result </pre> The full path of the INI file must be given, however, it is acceptable to use something similar to ".\myfile.ini" to indicate a file in the current working directory.

IniWrite (4 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szFile	char *	character*4096	String	String	value	input	A string pointer to the filename of the .INI file.
szSection	char *	character*4096	String	String	value	input	A string pointer to the required section of the .INI file.
szValue	char *	character*4096	String	String	value	input	A string pointer to the value to read.
szResult	char *	character*4096	String	String	value	input	A string pointer to result to write.

x.x.x.42 Function 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.

ClipGet (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szText	char *	character*4096	String	String	value	output	A pointer to a string buffer that will receive the text from the clipboard.

x.x.x.43 Function 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.

ClipPut (1 arguments)

Name	C++	FORTRAN	VB	java	Pass By	Intent	Description
szText	char *	character*4096	String	String	value	input	A pointer to a string buffer that contains the text you want to send.