:function ActivateMenuBar
:Description Activates or deactivates the Menu bar for the active program. Same as pressing and releasing the ALT key.
:Category Menus

:function ActivateStartMenu
:Description Brings up the Start menu in Windows 95/98 or NT. Same as pressing CTRL+ESC.
:Category Menus

:function AddHook
:Description Installs a hook function. When a hook is in place, it is called right before every script is run, and passed the name of the script which activated the hook, and the frame name if the script is attached to a frame as its two parameters. If the hook returns TRUE, the script is allowed to execute. If the hook returns FALSE, the script will not be allowed to run. See the KeyboardHelp script and the KeyboardHelpHook function in DEFAULT.JSS for an example of a hook function in action.
:Param Int The type of hook to be installed. Use HK_SCRIPT for this parameter. Hook types are defined in HJConst.JSH.
:Param string The name of a function to be installed as a hook.
:Category Keyboard

:function AddTestSuite
:Synopsis Add a suite of tests to the TestRunner.
:Param Handle/hRunner The handle of the test runner to be released.  This is a handle that was generated in a call to GetTestRunner.
:Param String/strTests The name of the test suite to be added.
:Category Test

:function AltLeftMouseClick
:Description Simulates holding down the ALT key and clicking the left mouse button.
:Category Mouse

:function AppendToClipboard
:Synopsis Adds a string of text to the end or the beginning of the Windows Clipboard.
:Description The previous clipboard contents are retained and the new text added to the front or end.  Appended items are separated by blank line space.  Only plain text can be appended to the Clipboard.
:Returns Int TRUE if the item was appended.  FALSE if there was nothing to append to or if the clipboard update failed.
:Param String The string to append.
:Param Int TRUE if adding string to the End.  FALSE if adding to the front.
:Category Clipboard

:function AttributeEnumerate
:Synopsis Finds each field in a window with the specified attribute and calls a callback function with the field's rectangular coordinates.
:Description This function provides a quick method of enumerating all fields in a window with a specified attribute. For each field found, the coordinates of the bounding rectangle are passed to the callback function. If the callback function returns false then the enumeration stops. the callback function must take the following parameters: int topLeftX, int topLeftY, int bottomRightX, int bottomRightY. It must return true to continue the enumeration or false to abort the enumeration.
:Returns Int the number of fields found in the window.
:Param Handle/hWnd the window to enumerate.
:Param Int/iAttributes the attributes of the text to find.
:Param String/sCallback the callback function name.
:Category Text Format

:function Beep
:Description This is  used to make the PC beep. It can be included within an If...Then...Else...statement so that when a certain condition is present, the PC will beep.
:Category Sounds

:function BottomOfColumn
:Description When inside a table or spreadsheet, moves the active cursor to the bottom of the current column.
:Returns Int TRUE if the cursor moved, FALSE otherwise.
:Category Tables

:function BrailleAddBrlCursorLine
:Description This function is used To add the contents of the line at the Braille cursor to the display in Structured mode. It is different to BrailleAddFocusLine because it uses the line at the Braille cursor rather than the PC cursor. It is primarily required in virtual documents when Brailling table data.
:Returns Int True if successful, false otherwise.
:Category Braille Output

:function BrailleAddFocusItem
:Description Used from within the BrailleBuildLine function to add the contents of the current control to the data to be shown on the Braille display.
:Category Braille Output

:function BrailleAddFocusLine
:Description Used from within the BrailleBuildLine function to add the contents of the current line to the data to be shown on the Braille display.
:Returns Int True if successful, false otherwise.
:Category Braille Output

:function BrailleAddFrame
:Description Used to Braille a frame.
:Returns Int TRUE if the frame exists and was added, FALSE otherwise.
:Param String/FrameName the name of the frame  to be added.
:Optional
:Param Int/iAttribs attributes of text to include.
:Param Int/iTextColor text color of text to include.
:Param Int/iBackgroundColor background color of text to include.
:Category Braille Output

:function BrailleAddString
:Description Used with in BrailleBuildLine to add text to the Braille display.
:Returns Int TRUE if successful, FALSE otherwise.
:Param String/Buffer Text to be added.
:Param Int/XPosition The X position for the mouse to click if a routing button is pressed over any of the cells in this string. This value is used along with Y position to determine where to click. Make both values 0 if no click should happen.
:Param Int/YPosition the Y position for the mouse to click if a routing button is pressed over any of the cells in this string. This value is used along with X position to determine where to click. Make both values 0 if no click should happen.
:Param Int/Attributes Combination of the ATRIB_xxx values from HJCONST.JSH that indicate the attributes of the characters in this string.
:Category Braille Output

:function BrailleAddTextBetween
:Synopsis Like BrailleAddFocusItem but allows specification of starting and ending x-coordinate on current line.
:Description This function adds the text between the specified coordinates to the Braille display. It is used in situations where you do not wish to show the entire line but do wish to show the cursor context as you edit in this area of the line. It is used for example in MSWord 2000 and above in table cells.
:Returns Void
:Param Int/x1 the starting coordinate on the line.
:Param Int/x2 the ending coordinate on the line.
:Category Braille Output

:function BrailleAutoAdvanceMode
:Synopsis Starts or stops Braille Auto Advance Mode.
:Description When Auto Advance Mode is enabled, JAWS will automatically pan through documents at the specified speed. Panning stops either at the bottom of the document, focus changes, a routing button is pressed or this function is called again with the iMode parameter set to FALSE. If a Flash Message is displayed, Auto Advance is paused until the Flash message is manually or automatically cleared. The user may still pan left or right while the mode is active. the timer will be restarted so that the user may reread the new information.
:Returns int TRUE if the feature was successfully enabled or disabled.
:Param int/iMode Set to TRUE to turn the mode on, FALSE to turn it off.
:Optional
:Param int/nInterval optional duration between pans, if not supplied, defaults to the value of OPT_BRL_AUTOADVANCE_INTERVAL.
:Category Braille Navigation

:function BrailleAutoAdvanceModeActive
:Synopsis Enables the user to query if the Braille auto Advance mode is active.
:Description When Auto Advance Mode is enabled, JAWS will automatically pan through documents at the specified speed. Panning stops either at the bottom of the document, focus changes, a Flash Message is displayed or the feature is explicitly disabled. The user may still pan left or right while the mode is active. the timer will be restarted so that the user may reread the new information.
:Returns int TRUE if the feature is active, FALSE otherwise.
:Category Braille Navigation

:function BrailleBuildStatus
:Description Builds the line of Braille to be displayed in the status cells.
:Returns Void
:Category Braille Output

:function BrailleClearMessage
:Synopsis Clears the current Flash message.
:Description This function clears the current Flash message.
:Optional
:Param int/iIgnoreIfInfinite if TRUE and the message time is set to infinite, the message will not be cleared, it defaults to FALSE.
:Category Braille Output

:function BrailleCount
:Synopsis Retrieves the number of Braille displays configured in JAWS
:Returns Int the number of Braille displays configured in JAWS
:Category Settings

:function BrailleCursor
:Description Turns on the Braille cursor. This cursor is only used internally by the Braille scripts and should never be left on after a script completes its work.
:Category Cursors

:function BrailleDisplayLoadErrors
:Synopsis Retrieves whether or not JAWS displays an error to the user when the Braille display at the specified index fails to load
:Returns Int TRUE if the error should be displayed, FALSE otherwise
:Param int/nIndex the index of the Braille display
:Category Settings

:function BrailleDriver
:Synopsis Retrieves the driver name of the Braille display at the specified index
:Returns String The driver name of the requested Braille display, or "" if there is not a Braille display at that index.
:Param int/nIndex the index of the Braille display whose driver name is to be retrieved
:Category Settings

:function BrailleDriverInformation
:Synopsis Retrieves the driver information of the Braille display at the specified index
:Returns String The driver information string of the requested Braille display, or "" if there is not a Braille display at that index.
:Param int/nIndex the index of the Braille display whose driver information string is to be retrieved
:Category Settings

:function BrailleG2StringLength
:Description Determines the length of the translation to grade two Braille of a given string.
:Returns Int The length of the given string when translated to grade two Braille.
:Param string String of interest.
:Category Braille Output

:function BrailleGetCellCount
:Synopsis Gets the number of cells available on the attached Braille Display.
:Description this function returns the number of cells on the installed and active Braille display.
:Returns Int The number of cells.
:Category Braille Device

:function BrailleGetCursorDots
:Description Retrieves the DOT pattern used to show the active cursor on the Braille display.
:Returns String The DOT numbers used to show the active cursor. For example, "78."
:Category Braille Output

:function BrailleGetDeviceInfo
:Synopsis Gets the Braille Display's driver name, Model Name and Port string.
:Description This function gets the Braille Display's driver library name, its model name and its port string.
:Returns Int true if a Braille Display is found, False otherwise.
:Param String/ByRef/sDriver Driver name.
:Param String/ByRef/sName Display Name.
:Param String/ByRef/sPort Port String.
:Category Braille Device

:function BrailleGetFramePrompt
:Synopsis Returns the Braille prompt associated with the frame specified.
:Description This function retrieves the Braille prompt of the specified frame. If no frame is specified then the frame at the active cursor location is asumed. Note that a frame's prompt is any string or strings defined as part of any EVENT_Focus/ACTION_BrailleString pairs.
:Returns String the Braille prompt.
:Optional
:Param String/sName the name of the frame whose prompt you want.
:Category Frames

:function BrailleGetStateString
:Synopsis Returns a string defining the state for the specified state flags.
:Description This function returns the state string as defined in the app or default jbs for the specified state flags. This may be a combination of strings. The state flags maybe any combinations of the CTRL_XX attributes defined in hjconst.jsh, eg CTRL_CHECKED etc.
:Returns String the state string.
:Param Int/nState the state flags.
:Category Braille Output

:function BrailleGetStatusCellCount
:Description Returns the number of status cells on the currently attached Braille display.
:Returns Int The number of status cells, or 0 if no Braille display is connected.
:Category Braille Device

:function BrailleGetSubtypeDisplayName
:Synopsis Returns the type display name defined for the supplied type constant.
:Description This function returns the type display name as defined in the app or default jbs for the specified type constant. Note that if no value is defined for a standard window type's displayname key in the jbs, the default string spoken for that type will be returned.
:Returns String the type display name.
:Param Int/nType either one of the wt_typeCode constants or a constant representing a custom control ie wt_custom_control_base+customControlCode.
:Category Braille Output

:function BrailleGetSubtypeString
:Synopsis Returns the type string defined for the supplied type constant.
:Description This function returns the type string as defined in the app or default jbs for the specified type constant.
:Returns String the type string
:Param Int/nType either one of the wt_typeCode constants or a constant representing a custom control ie wt_custom_control_base+customControlCode.
:Category Braille Output

:function BrailleGetTypeKeysMode
:Synopsis Retrieves TypeKeys mode state available in Freedom Scientific Braille displays.
:Description When TypeKeys mode is enabled, characters typed using the display are inserted into the application with focus.
:Returns int TRUE if TypeKeys mode is enabled, FALSE otherwise.
:Category Braille Keyboard

:function BrailleInUse
:Description Checks to see if a Braille display is in use.
:Returns Int TRUE if Braille display is being used, FALSE otherwise.
:Category Braille Device

:function BrailleIsMessageBeingShown
:Synopsis Determines if a Flash message is currently being shown on the display.
:Description This function Determines if a Flash message is currently being shown on the display, ie if the user has called BrailleMessage or internal code has called ShowMessage.
:Returns int true or false.
:Category Braille Output

:function BrailleIsStructuredLine
:Description Determines if the Braille line is a structured line. Only applicable when using Structured mode.
:Returns Int True if line is structured, false otherwise.
:Category Braille Output

:function BrailleLine
:Description Sends the current line of text to a Braille display. It is automatically executed ten times per second and does not need to be routinely used by a script. It can be used in a script after the BrailleString function has been used and you are ready to display a line of information from the desktop.
:Returns Void
:Optional
:Param int/whichRange If the entire line will not fit on the Braille display, then this indicates which portion to show.  Should be one of the brlShowXXX constants in hjconst.jsh.
:Category Braille Output

:function BrailleLongName
:Synopsis Retrieves the descriptive name of the Braille display at the specified index
:Returns String The descriptive name of the requested Braille display, or "" if there is not a Braille display at that index.
:Param int/nIndex the index of the Braille display whose name is to be retrieved
:Category Settings

:function BrailleMessage
:Synopsis Sends a Flash message to the display.
:Description This function sends a Flash message to the display which is held on the display for the specified length of time. You may append messages together by using the second optional parameter. If you do not specify the duration of the message or the append flag, the duration will default to the value of the OPT_BRL_MESSAGE_TIME JCF option and the message will replace any existing message.
:Returns void
:Param string sMessage the message to send.
:Optional
:Param int/iAppend if non-zero, the message will be appended to the existing message, if 0, the message will replace the current message.
:Param int/tiMS the time in milliseconds to keep the message on the display before restoring the display to the prior content.
:Category Braille Output

:function BrailleMessageRepeatLast
:Synopsis Reshows the last Flash message on the Braille display.
:Description This function reshows the last Flash message that was sent to the Braille display. It is shown for the same duration as it was originally shown for and with the same prefix. This works even if Flash Messages have been disabled.
:Returns int True if the last message was repeated, False if no messages have yet been shown.
:Category Braille Output

:function BrailleName
:Synopsis Retrieves the name of the Braille display at the specified index
:Returns String The name of the requested Braille display, or "" if there is not a Braille display at that index.
:Param int/nIndex the index of the Braille display whose name is to be retrieved
:Category Settings

:function BrailleNextLine
:Description Moves the Braille cursor one line down and shows the new line.
:Returns Int "WAS_SUCCESSFUL" = 1,"WAS_NOT_SUCCESSFUL" = 0.
:Category Braille Navigation

:function BraillePanLeft
:Description Displays the prior group of Braille characters from the line with the active cursor. The characters that are displayed when this function is used are those that precede the first character on the current display of Braille characters. For example, the display moves or pans to the left to reveal additional text.
:Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.
:Optional
:Param Int true to move to the last segment of the prior line if no more text to the left, default value is false.
:Category Braille Navigation

:function BraillePanRight
:Description Displays the next group of Braille characters from the line with the active cursor. The characters that are displayed when this function is used are those that follow the last character on the current display of Braille characters. For example, the display moves or pans to the right to reveal additional text.
:Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.
:Optional
:Param Int true to move to the first segment of the next line if no more text to the right, default value is false.
:Category Braille Navigation

:function BraillePort
:Synopsis Retrieves the port name of the Braille display at the specified index
:Returns String The port name of the requested Braille display, or "" if there is not a Braille display at that index.
:Param int/nIndex the index of the Braille display whose port name is to be retrieved
:Category Settings

:function BraillePortString
:Synopsis Retrieves the port string of the Braille display at the specified index
:Returns String The port string of the requested Braille display, or "" if there is not a Braille display at that index.
:Param int/nIndex the index of the Braille display whose port string is to be retrieved
:Category Settings

:function BraillePriorLine
:Description Moves the Braille cursor one line up and shows the new line.
:Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.
:Category Braille Navigation

:function BrailleRefresh
:Description Used to refresh the Braille display and redisplay the appropriate text.
:Returns Void
:Optional
:Param int/whichRange If the entire line will not fit on the Braille display, then this indicates which portion to show.  Should be one of the brlShowXXX constants in hjconst.jsh.
:Category Braille Output

:function BrailleRoutingButton
:Description Attempts to move the PC cursor to the location designated by the braille cell.
:Param int The 1-based number of a braille cell.
:Category Braille Navigation

:function BrailleSetColorsToMark
:Synopsis Allows user to specify the foreground and background colors of up to 9 color pairs which should be marked in Braille with DOTS 7 and 8.
:Description This function allows the user to specify the foreground and background colors of up to 9 color pairs which should be marked in Braille with DOTS 7 and 8. This function also toggles the Braille Mark Colors to on. Supply an empty string to turn off color marking or set the JCF option to exclude marking colors.
:Returns Void
:Param String up to 9 pairs of text and background colors of the form rgb/rgb,rgb/rgb,... Supply empty string to turn off color marking.
:Category Colors

:function BrailleSetCursorDots
:Description Sets the DOT pattern used to represent the active cursor on the Braille display.
:Param String/DotPattern The DOT numbers used to show the active cursor. For example, "78."
:Category Braille Output

:function BrailleSetStatusCells
:Description Puts characters on the status cells of the Braille Display. This function should only be called from within a BrailleBuildStatus function.
:Param String/StatusText Characters to be placed in the Braille status cells.
:Category Braille Output

:function BrailleSetTypeKeysMode
:Synopsis Sets the TypeKeys mode to the value specified by bEnable.
:Description When TypeKeys mode is enabled, characters typed using the display are inserted into the application with focus.
:Returns int TRUE if the value is properly set, FALSE otherwise.
:Param int/bEnable Set to TRUE to enable TypeKeys mode, FALSE otherwise.
:Category Braille Keyboard

:function BrailleString
:Description Sends the specified string to the Braille display regardless of whether or not the line is visible.
:Param String/strBuffer String to be sent to the Braille display.
:Category Braille Output

:function BrailleSupportsTypeKeysMode
:Synopsis Determines whether or not TypeKeys mode is supported by at least one of the loaded Braille drivers.
:Returns int TRUE if the mode is supported, FALSE otherwise.
:Category Braille Keyboard

:function BrailleSwitchTransLanguage
:Synopsis Switches to a Braille Translation engine appropriate for the specified language.
:Returns Int true on success, false otherwise.
:Param String language abbreviation, eg enu, deu, etc.
:Category Braille Output

:function CaretVisible
:Description Indicates whether an insertion point or a caret is visible in the active window. The function returns a constant value of TRUE to indicate that a caret is visible and a value of FALSE to indicate that it is not visible.
:Returns Int "TRUE" = 1, "FALSE" = 0.
:Category Cursors

:function CenterMouseInView
:Synopsis Centers the mouse in the active view.
:Description The mouse is centered both horizontally and vertically. If MAGic is running and the screen is magnified, then the mouse is centered in the active view. Otherwise, the mouse is placed in the center of the display.
:Category MAGic

:function CheckAuthScheme
:Description A call to this function determines if  JAWS is authorized to run. For the dongle, a check is done to ensure the dongel is installed and that it is the correct one for the product .
:Returns Int 0 if dongle is in place and authorized correctly, error code otherwise.
:Category FS Product Info

:function ClickObjectByName
:Description Does a LeftMouse click at the upper lefthand corner of the named object. This function relies on MSAA and is ideal for clicking an object that does not have its own window but for which you know the name.
:Returns int TRUE if the object was found and could be clicked, false otherwise.
:Param HANDLE/hwnd The window containing the object of interest
:Param string/ObjectName The name of the object desired
:Optional
:Param int/nWhichOccurance If there is more than one object with this name, which one  is desired.  This parameter defaults to 1.
:Category Object Model And MSAA

:function ClipboardHasData
:Description This function will return true if there is any data at all on the Windows clipboard.
:Returns Int True if the clipboard contains data, false otherwise.
:Category Clipboard

:function ColorToRGBString
:Description Converts a color value to a string of the form "255255255" where the first three digits represent the proportion of red, the second three digits the proportion of green, and the third three digits the proportion of blue.
:Returns String The color value converted to an RGB string.
:Param Int The color value to be used.
:Category Colors

:function ControlCanBeChecked
:Description Determines whether or not the current control can be checked.
:Returns Int 0 if cannot be checked or 1 can be checked.
:Category Dialog Controls

:function ControlEnterKey
:Synopsis The ControlENTER key is passed to the application.
:Description Passes the ControlEnter key through to the application. If the virtual cursor is active and on an element with an OnMouseOver handler then the OnMouseOver handler is activated for that element.
:Returns Void
:Category Keyboard

:function ControlIsChecked
:Description Determines whether or not the current control is checked.
:Returns Int Returns true or false.
:Category Dialog Controls

:function ControlLeftMouseClick
:Description Sends a Control Left Mouse click to the system, useful for selecting non-contiguous items in a list.
:Category Mouse

:function CopyToClipboard
:Description Puts a string of text onto the Windows clipboard erasing any previous clipboard contents. In order to copy multiple lines of text, these must be concatenated together into a single string before calling CopyToClipboard. In the concatenated string, lines should be separated with \r\n.
:Param String/ClipboardData Text to be copied to the Windows clipboard.
:Category Clipboard

:function CreateObject
:Description In applications such as Internet Explorer or those found in Microsoft Office, launches an application under the control of JAWS, which is the automation object. The difference between CreateObject and GetObject is that GetObject creates a pointer to an automation object that already exists, whereas CreateObject creates the automation object for the application.
:Returns Object The automation object associated with the program.
:Param String/ApplicationName Name of the COM class that can return an automation object.
:Category Object Model And MSAA

:function CreateObjectEx
:Description In applications such as Internet Explorer or those found in Microsoft Office, launches an application under the control of JAWS, which is the automation object. The difference between CreateObject and GetObject is that GetObject creates a pointer to an automation object that already exists, whereas CreateObject creates the automation object for the application.
:Returns Object The automation object associated with the program.
:Param String/ApplicationName Name of the COM class that can return an automation object.
:Param Int TRUE = Same behavior as CreateObject. FALSE = Will always force the use of CoCreateInstance instead of using GetObjectHelper when JAWS is running as a service.
:Category Object Model And MSAA

:function DecToHex
:Synopsis converts a decimal integer to a hex string
:Description This function converts a decimal integer to a hex string.
:Returns string The hex value
:Param int/iDec decimal value
:Category Misc

:function Delay
:Description Makes a script stand still for a specified period of time. It causes a script to stop, wait a period of time, and then resume again. It is different than the Pause function which yields to the processing needs of applications.
:Param Int Type a number to indicate the amount of time that the script should be delayed. The number 1 equals one-tenth of a second. The number 10. equals one second. Do not use numbers withdecimals, and do not use quotation marks.
:Optional
:Param Int/nNoEvents TRUE to suppress checking for and processing FocusChangedEvent and NewTextEvent functions before returning from the delay.
:Category Scripts

:function DialogActive
:Description Used to determine whether a dialog box is currently active. It returns a constant value to indicate the status: ACTIVE indicates that a dialog box is active, and INACTIVE indicates that a dialog box is not active. These constants can be used in If...Then...Else...statements.
:Returns Int  "ACTIVE" = 1, "INACTIVE" = 0.
:Category Dialogs

:function DlgCustomizeListview
:Synopsis Displays Listview column headers options.
:Description Displays a dialog that contains options for indicating how Listview column headers are spoken or brailled.
:Returns Void
:Param Handle/hwnd The handle of the Listview of interest.
:Category User Interaction

:function DlgGetCustomSummaryInfo
:Synopsis Displays dialog for labeling cells.
:Description Displays a dialog that contains options for labeling cells and cell ranges in spreadsheets.
:Returns Void
:Param String/sSection The name of the worksheet.
:Param String/sKey The name of the cell or cell range (Example, A1 or A1:B1).
:Param String/sValue The description for the cell or cell range.
:Param String/sFileName The file name of the JSI file.
:Category User Interaction

:function DlgListOfPlaceMarkers
:Synopsis Displays a dialog containing a list of PlaceMarkers.
:Description PlaceMarkers dialog provides Add,MoveTo,ChangeName,Remove and RemoveAll PlaceMarker capabilities.
:Returns Int TRUE if successful, returns FALSE otherwise.
:Param Int/nAdd 1 to pop up Add dialog,bypassing PlaceMarkers dialog, 0 to display PlaceMarkers dialog.
:Category HTML

:function DlgSelectControls
:Description Displays a list box containing controls you may want to perform any one of the following actions: right single click, left single click, left double click, or Move To.  You may change the dialog window title, display any combinations of the buttons, and specify a default.
:Returns Int An integer value indicating what type of mouse action is required to activate the selected task tray icon, whether it be Left Mouse Button, Right Mouse Button, or double click of the left mouse button.
:Param String/strGraphicList The list of controls.
:Param Int/nIdx/ByRef The number of controls.
:Param String/strWindowTitle The new window title.
:Param Int/nMask The mask that indicates the buttons desired.  See the available buttons in HjConst.jsh with the prefix bt_.
:Param Int/nDefault The default button as specified by the mask value.
:Category User Interaction

:function dlgSelectFunctionToRun
:Description Presents a list of functions to be run and displays their current value.  Pressing the space bar or the Execute button will change the return value of the selected function, based on how the function was written.  It is much like dlgSelectScriptToRun except that it does not merely speak, but the new return values are placed in the list box.
:Param String strList This is the delimited list to be presented in the list box.  It is in the same format as the dlgSelectScriptToRun function.
:Param String/strDialogName Enter the string consisting of the Dialog's name.
:Param Int/iSort Enter True if the items are to be sorted alphabetically, false otherwise.
:Category User Interaction

:function DlgSelectItemInList
:Description Displays a dialog that contains a set of menu items. When the dialog is okayed, the one based index of the selected item is returned.
:Returns Int This is 0 if the dialog was cancelled, otherwise the one based index of the selected item.
:Param String/Items A "/007" delimited set of menu items.
:Param String/DialogName A string containing the name you want to appear as the title for the Menu Select dialog.
:Param Int/nSort If TRUE, then the contents of the list will be sorted.
:Optional
:Param Int/nDefaultSelectedIndex the index of the item which should have the focus when the dialog is invoked. (JAWS 5.0 and above)
:Category User Interaction

:function DlgSelectScriptToRun
:Description Displays a dialog that contains a set of scripts. Scripts can be performed from this dialog.
:Param String/Scripts A "/007" delimited set of script names. Aliases can also be included in this list. Example: ScriptDialog (VerbosityLevel:Verbosity/007ScreenEcho). This would create a listbox containing entries; Verbosity and ScreenEcho.
:Param String/DialogName A string containing the name you want to appear as the title for the script dialog. If this parameter is "", "Perform Script" is used for the title.
:Param Int/nSort If TRUE, then the contents of the list will be sorted.
:Category User Interaction

:function DlgSkimRead
:Synopsis Displays Skim Reading options.
:Description Displays a dialog that contains options for indicating how Skim Reading is performed.
:Returns Void
:Category User Interaction

:function DlgSysTray
:Description Displays a list box containing the icons on the System Tray
:Returns Int An integer value indicating what type of mouse action is required to activate the selected task tray icon, whether it be Left Mouse Button, Right Mouse Button, or double click of the left mouse button.
:Param String/strGraphicList The list of Task tray icons.
:Param Int/nIdx The number of Task tray icons.
:Category User Interaction

:function DownCell
:Description When inside a table or spreadsheet, moves the active cursor to the same cell in the next row.
:Returns Int TRUE if the cursor moved, FALSE otherwise.
:Category Tables

:function DragItemWithMouse
:Description The drag-and-drop function is used to move the contents of one area of the screen to another area of the screen.
:Param Int/SourceX The X coordinate of the item that is to be moved.
:Param Int/SourceY The Y coordinate of the item that is to be moved.
:Param Int/TargetX The X coordinate of the target location for the item.
:Param Int/TargetY The Y coordinate of the target location for the item.
:Category Mouse

:function ElIf
:Description Instead of using an Else operator in an If...Then...Else...statement, you may want to use an ElIf operator. The statement could then be reconstructed as an If...Then...ElIf...Then...Else...statement. Every statement must end with an EndIf operator. The script functions that appear between the ElIf and the Then are used to evaluate whether a certain condition is present
:Category Control Flow

:function Else
:Description The Else operator is an optional part of an If...Then...Else... statement. If...Then...Else...statements always ask a question about whether something is true or false, That is, is a condition present or not present. When the condition is not present (false), then the actions that follow the Else are performed. An If...Then...Else...statement must always include: If...Then...EndIf. The Else is optional
:Category Control Flow

:function EndIf
:Description The EndIf operator marks the end of an If...Then...Else...statement. A fully formulated If...Then...Else..statement includes If...Then...Else...EndIf. The EndIf is always required to terminate the If...Then...Else...statement
:Category Control Flow

:function EndOfRow
:Description When inside a table or spreadsheet, moves the active cursor to the end of the current row.
:Returns Int TRUE if the cursor moved, FALSE otherwise.
:Category Tables

:function EndWhile
:Description The EndWhile operator marks the end of a While loop. The script functions that are to be repeated must be placed between While and EndWhile.
:Category Control Flow

:function EnterKey
:Synopsis The ENTER key is passed to the application.
:Description Passes the enter key through to the application. If the Virtual PC cursor is positioned on a link or button, it is activated. If the Virtual PC cursor is on another form control, Forms Mode is activated.
:Category Keyboard

:function EnumerateChildWindows
:Synopsis For each child of the specified window, calls a callback script function which may optionally process the window and either stop or continue the enumeration.
:Description This function calls a specified function for each child of the starting window. This function must be defined as: int function SomeName(handle hwnd). This function must return true if the enumeration should continue or false if it should stop.
:Returns Int true if the enumeration completed, false if it was terminated by the callback function returning false for a window.
:Param Handle/hWnd starting handle.
:Param String/sFunctionCallback The name of the script function to call for each child window.
:Category Window

:function ExMessageBox
:Synopsis Displays a Windows Standard Message Box.
:Description This function displays a Windows Standard Message Box.  It is very much like the function MessageBox except it allows you to specify the Message Box title and the type of message box (i.e. The buttons that are used and the icon that is to be displayed).  This function also returns a value that indicates which button was pressed on the Message Box.
:Returns Int Returns an integer value indicating which button was pressed on the message box.
:Param String/strMsg The text of the message that you would like to be displayed in the main body of the message box.
:Param String/strTitle The text of the Message Box's title.
:Param Int/iType One or more of the Message Box type specifiers that are listed in HJConst.jsh, separated by a single vertical bar.  An example of such is:  MB_YESNOCANCEL|MB_DEFBUTTON1  making the Yes button the default.
:Category User Interaction

:function FileExists
:Description Checks to see if the specified path exists.
:Returns Int TRUE if the path exists.
:Param String/strFile The file to be checked.
:Category Files

:function FilenameGetNearestMatch
:Synopsis finds a file whose name most closely matches the given name.
:Description This function looks for a file whose name most closely matches the supplied name. The function uses the second two parameters to narrow the search. This function is most useful in locating JSI files to associate settings with documents whose settings maybe similar, indicated by similar file names eg Excel monthly reports.
:Returns String The nearest matching filename to the one specified.
:Param String/sFileToMatch The filename (including optional path). If the path is not specified the script directory is assumed.
:Param Int/nMustMatchFirstNChars specifies the minimum number of characters of the filename's prefix which must match, eg if you are only interested in jsi files starting with excel_ then the value of this parameter would be 6.
:Param Int/nMustMatchExtention Set this to true if the extention must match.
:Category Files

:function FileNameList
:Synopsis Returns a delimited list of file names matching the specified criteria.
:Description This function returns a delimited list of file names matching the specified criteria. For example, to get a list of scheme files, pass in "*.smf" for the first parameter
:Returns String a delimited list of file names matching the specified criteria.
:Param String sFileNameMask filename mask optionally including path information. If no path is included, the settings/lang path is prepended
:Optional
:Param String sDelim the delimiter to separate filenames with. If no delimiter is supplied, \007 is used.
:Category Files

:function FindCaret
:Description allows the user to specify the coordinates of the system caret when JAWS is unable to locate it.
:Returns Int TRUE if the function is determining the correct caret location, false otherwise.
:Param Int/nX/ByRef set to x coordinate of caret.
:Param Int/nY/ByRef set to y coordinate of caret.
:Category Cursors

:function FindColors
:Description Searches for the occurrence of a specific combination of foreground and background colors. If the search is successful, the JAWS cursor is placed at the beginning of the text with the desired combination of colors.
:Returns Int The number is 1 if the search was successful, 0 if it was not successful.
:Param Int Type in a variable name or function that can provide the color value to be used as the foreground color. RGBStringToColor is often used as a parameter. Use the constant IgnoreColor defined in the file HJConst.jsh to ignore the foreground color and search only for the occurrence of the background color.
:Param Int Type in a variable name or function that can provide the color value to be used as the background color. RGBStringToColor is often used as a parameter. Use the constant IgnoreColor defined in the file HJConst.jsh to ignore the background color and search only for the occurrence of the foreground color.
:Param Int Type in one of the following constants defined in HJConst.jsh to indicate the direction of the search: s_top, to search from the top of the active window; s_bottom, to search from the bottom of the active window; s_next, to search forward from the position of the active cursor; s_prior, to search backward from the position of the active cursor.
:Optional
:Param int set this to TRUE to restrict the search to the window containing the active cursor, FALSE for an unrestricted search, if not supplied, defaults to FALSE, ie unrestricted. this optional parameter is only available in JAWS 6.0
:Category Colors

:function FindDescendantWindow
:Description Find the descendant window with the specified Control ID.
:Returns Handle The handle of the window that is found. This is 0 if the window is not found.
:Param Handle The handle of the parent window that will serve as the starting point for the search.
:Param Int The Control ID of the window for which you are searching.
:Category Window

:function FindFirstAttribute
:Description Searches for the first occurrence of text with certain attributes. It begins the search at the upper left corner of the specified window and moves downward. If the search is successful, then the active cursor is placed on the first character that has the desired attributes. Generally, the PC cursor can be successfully moved to attributes within a text window.
:Returns Int  "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.
:Param Int Type the name of the constant value for the attribute that is to be located: ATTRIB_BOLD, ATTRIB_UNDERLINE, ATTRIB_ITALIC, ATTRIB_HIGHLIGHT, and ATTRIB_STRIKEOUT. You can search for a combination of attributes by placing a PLUS SIGN (+) between constants. For example, ATTRIB_BOLD+ATTRIB_UNDERLINE.
:Optional
:Param int set this to TRUE to restrict the search to the window containing the active cursor, FALSE for an unrestricted search, if not supplied, defaults to FALSE, ie unrestricted. this optional parameter is only available in JAWS 6.0
:Category Text Format

:function FindGraphic
:Description FindGraphic searches for a graphic in the specified window. If the graphic is found, then the JAWS cursor is placed on it. The graphic must have a text label associated with it because the FindGraphic function searches for text labels. Text labels are assigned by the Graphics Labeler.
:Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.
:Param Handle Specify a window handle. Type the name of a variable or choose a script function that indicates the window that is to be searched.
:Param String Type the graphic label that is to be located. The label must be typed exactly as it appears in the graphic label file. Enclose the graphic label within quotation marks.
:Param Int Indicate the search direction. Type a constant value to indicate the starting point for the search: S_TOP or S_BOTTOM.
:Param Int Indicate search restriction. Type the name of a constant value to indicate whether the search should be restricted to the active window or it should extend into all child windows of the active application. Type S_UNRESTRICTED to search all application windows or S_RESTRICTED to limit the search to the active child window.
:Category Graphics

:function FindJAWSHelpFile
:Description Retrieves the full path to the specified JAWS help file. This will depend in part on the current language.
:Returns String Full path to the specified JAWS help file.
:Param String/strHelpFile Name of the desired help file.
:Category JAWS Program

:function FindJAWSHomeFile
:Description Retrieves the full path to the specified file in the JAWS home directory.
:Returns String Full path to the specified JAWS file.
:Param String/strFile Name of the desired file.
:Category JAWS Program

:function FindJAWSPersonalizedSettingsFile
:Description Retrieves the full path to the specified JAWS personalized settings file. This will depend in part on the current language; it may also depend on the current logged-in user.
:Returns String Full path to the specified JAWS personalized settings file.
:Param String/strSettingsFile Name of the desired personalized settings file.
:Optional
:Param Int TRUE if the file is to be created in the user's personalized settings directory.
:Category JAWS Program

:function FindJAWSSettingsFile
:Description Retrieves the full path to the specified JAWS settings file. This will depend in part on the current language; it may also depend on the current logged-in user.
:Returns String Full path to the specified JAWS settings file.
:Param String/strSettingsFile Name of the desired settings file.
:Optional
:Param Int TRUE if the file is to be created in the user's settings directory.
:Category JAWS Program

:function FindJAWSSoundFile
:Description Retrieves the full path to the specified JAWS sound file. This will depend in part on the current language; it may also depend on the current logged-in user.
:Returns String Full path to the specified JAWS settings file.
:Param String/strSettingsFile Name of the desired settings file.
:Optional
:Param Int TRUE if the file is to be created in the user's settings directory.
:Category JAWS Program

:function FindJAWSUtilityProgram
:Description Retrieves the full path to the specified JAWS utility program.
:Returns String Full path to the specified JAWS utility program.
:Param String/strUtility Name of the desired utility program.
:Category JAWS Program

:function FindLastAttribute
:Description Searches for the last occurrence of text with certain attributes. It begins the search at the lower right corner of the active window and moves up to the upper left corner of the window. If the search is successful, then the active cursor is placed on the first character that has the desired attributes. Generally, the PC cursor can be successfully moved to attributes within a text window.
:Returns Int  "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0. "FALSE" = search failure.
:Param Int Type the name of the constant value for the attribute that is to be included in the search:  ATTRIB_BOLD, ATTRIB_UNDERLINE, ATTRIB_ITALIC, ATTRIB_HIGHLIGHT, and ATTRIB_STRIKEOUT. You can search for a combination of attributes by placing a PLUS SIGN (+) between constants. For example, ATTRIB_BOLD+ATTRIB_UNDERLINE.
:Optional
:Param int set this to TRUE to restrict the search to the window containing the active cursor, FALSE for an unrestricted search, if not supplied, defaults to FALSE, ie unrestricted. this optional parameter is only available in JAWS 6.0
:Category Text Format

:function FindNextAttribute
:Description Searches for the next occurrence of text with certain attributes. The search begins at the location of the active cursor and moves down through the remainder of the active window. If the search is successful, then the active cursor is placed on the first character that has the desired attributes. Generally, the PC cursor can be successfully moved to attributes within a text window.
:Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.
:Param Int Type the name of the constant value for the attribute that is to be located: ATTRIB_BOLD, ATTRIB_UNDERLINE, ATTRIB_ITALIC, ATTRIB_HIGHLIGHT, and ATTRIB_STRIKEOUT. You can search for a combination of attributes by placing a PLUS SIGN (+) between constants. For example, ATTRIB_BOLD+ATTRIB_UNDERLINE.
:Optional
:Param int set this to TRUE to restrict the search to the window containing the active cursor, FALSE for an unrestricted search, if not supplied, defaults to FALSE, ie unrestricted. this optional parameter is only available in JAWS 6.0
:Category Text Format

:function FindPriorAttribute
:Description Searches for the prior occurrence of text with certain attributes. It begins the search at the location of the active cursor and moves up through the remainder of the active window. If the search is successful, then the active cursor is placed on the first character that has the desired attributes. Generally, the PC cursor can be successfully moved to attributes within a text window.
:Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.
:Param Int Type the name of the constant value for the attribute that is to be included in the search:  ATTRIB_BOLD, ATTRIB_UNDERLINE, ATTRIB_ITALIC, ATTRIB_HIGHLIGHT, and ATTRIB_STRIKEOUT. You can search for a combination of attributes by placing a PLUS SIGN (+) between constants. For example, ATTRIB_BOLD+ATTRIB_UNDERLINE.
:Optional
:Param int set this to TRUE to restrict the search to the window containing the active cursor, FALSE for an unrestricted search, if not supplied, defaults to FALSE, ie unrestricted. this optional parameter is only available in JAWS 6.0
:Category Text Format

:function FindString
:Description FindString searches for a string of text in a specified window. If the text is found, then the JAWS cursor is placed at the beginning of the text string
:Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.
:Param Handle Specify a window handle. Type the name of a variable or choose a script function to provide the handle of the window that is to be searched.
:Param String Specify the text that is to be located. Type a text string, or type a variable name or choose a script function that can provide the text. Text strings must be enclosed within quotation marks.
:Param Int Indicate the search direction. Type the name of a constant value to indicate the direction of the search: S_TOP or S_BOTTOM.
:Param Int Indicate search restriction. Type the name of a constant value to indicate whether the search should be restricted to the active window or it should extend into all child windows of the active application. Type S_UNRESTRICTED to search all application windows or S_RESTRICTED to limit the search to the active child window.
:Category Strings

:function FindTopLevelWindow
:Description Find the top level window with the specified window class and/or window name. If you do not wish to search based on one of the arguments, use "" for that argument
:Returns Handle The handle of the window that is found. This is 0 if the window is not found.
:Param String The window class that will be used to find the desired window.
:Param String The window name that will be used to find the desired window.
:Category Window

:function FindWindow
:Synopsis finds a window with a specified class or name.
:Description This function starts at the specified window and searches all of its children to find one with the specified Class or Window Name. If the handle is 0 then a top level window is sought (ie equivalent to calling FindTopLevelWindow). Leave the name blank to find a window with a class but any name or leave the class blank to find a window with any class but a particular name.
:Returns Handle the window handle of the found window.
:Param Handle/hStart starting window.
:Param String/sClass class name to search for.
:Optional
:Param String/sWindowName the name of the window to find.
:Category Window

:function findWindowByType
:Synopsis Finds a child window by its type.
:Description This function allows the scripter to find a child window of a given window with a specified window type.
:Returns handle the handle of the window with the specified type if found, or 0 if no window with the specified type exists under the starting window's hierarchy.
:Param handle the starting window
:Param int the window type (one of the WT_ constants from hjconst.jsh).
:Category Window

:function FindWindowsSystemFile
:Description Retrieves the full path to the specified Windows system file.
:Returns String Full path to the specified WIndows system file.
:Param String/strSystemFile Name of the desired file.
:Category JAWS Program

:function FindWindowWithClassAndId
:Synopsis Finds a child window with a given control ID and class
:Description this function is useful when control IDs are not unique in an application and you need to find a child window with a given control ID and class name.
:Returns handle the handle of the window if found, NULL otherwise
:Param handle/hwnd starting handle
:Param string/sClass the class name
:Param int/ControlID the control ID of the child
:Category Window

:function FirstCell
:Description When inside a table or spreadsheet, moves the active cursor to the first cell.
:Returns Int TRUE if the cursor moved, FALSE otherwise.
:Category Tables

:function FormatString
:Description Formats the string you specify with the messages received as  subsequent parameters.  The message to be formatted must be delimited with the parameter place holder delimiters, such as %1 %2 %3 %4 %5
:Returns String the contents of Message with all place holders replaced by their associated parameters.
:Param String/Message string containing text intermingled with parameter place holders.
:Optional
:Param String item to be substituted in place of %1 every time it appears in Message.
:Param String item to be substituted in place of %2 every time it appears in Message.
:Param String item to be substituted in place of %3 every time it appears in Message.
:Param String item to be substituted in place of %4 every time it appears in Message.
:Param String item to be substituted in place of %5 every time it appears in Message.
:Param String item to be substituted in place of %1 every time it appears in Message.
:Param String item to be substituted in place of %1 every time it appears in Message.
:Param String item to be substituted in place of %1 every time it appears in Message.
:Param String item to be substituted in place of %1 every time it appears in Message.
:Param String item to be substituted in place of %1 every time it appears in Message.
:Category Strings

:function FormatStringWithEmbeddedFunctions
:Synopsis Formats a string with embedded functions.
:Description This function replaces each occurance of <func> with the result of calling the function func.
:Returns String The string with <func> occurances replaced by function result.
:Param String/SStr string with embedded functions.
:Category Strings

:function FormsModeEvent
:Synopsis Is activated whenever forms mode is entered or exited.
:Description This function is activated whenever forms mode is entered or exited. It is passed a boolian value indicating which of these actions has taken place. If bEntering is equal to true, forms mode has been turned on. If bEntering is equal to false, forms mode has been turned off.
:Param Int/bEntering This is the boolean value representing the current state of forms mode.
:Category HTML

:function FramesEnumerate
:Synopsis Enumerates all frames calling a script function for each frame defined.
:Description This function enumerates all defined and valid frames and calls a function for each frame passing in the name and rectangle tlx, tly, brx, bry for the frame.
:Returns Void
:Param String/Callback script function.
:Category Frames

:function FrameViewer
:Synopsis Launch the Frame Viewer
:Description Launch the Frame Viewer with information regarding a possible new frame creation.
:Returns void
:Param Int/iAction What action should the Frame Viewer perform.  Possible values are found in HJConst beginning with FRAMEVIEW_.
:Param Int/iEnclosingTop the screen coordinate for the top of the parent window for the new frame.
:Param Int/iEnclosingLeft the screen coordinate for the left of the parent window for the new frame.
:Param Int/iEnclosingBottom the screen coordinate for the bottom of the parent window for the new frame.
:Param Int/iEnclosingRight the screen coordinate for the right of the parent window for the new frame.
:Param Int/iFrameTop the screen coordinate for the top of the new frame.
:Param Int/iFrameLeft the screen coordinate for the left of the new frame.
:Param Int/iFrameBottom the screen coordinate for the bottom of the new frame.
:Param Int/iFrameRight the screen coordinate for the right of the new frame.
:Param String/strName the title of the parent window.
:Param String/strClass the class of the parent window.
:Param String/strPrompt the prompt that will be associated with this frame.
:Category Frames

:function FrameViewerActive
:Synopsis Determines whether or not the Frame Viewer is loaded and active.
:Description Since multiple instances of the Frame Viewer cannot be simultaneously loaded, this function is usefull for giving the user feedback when a second instance of the Frame Viewer is denied from launching.
:Returns Int TRUE if the Frame Viewer is active, otherwise FALSE.
:Category Frames

:function GetActiveConfiguration
:Synopsis retrieves the name of active configuration set.
:Description The Name is what is left when all of the path information is stripped away from the Active Configuration path.
:Returns String The name of the active configuration set.
:Category Settings

:function GetActiveCursor
:Description This determines which cursor is active.
:Returns Int CURSOR_JAWS = 0, CURSOR_PC = 1, CURSOR_INVISIBLE = 2, CURSOR_Braille = 3.
:Category Cursors

:function GetActiveCursorName
:Synopsis Returns the name of the active cursor.
:Description This function returns the name of the active cursor.
:Returns string the name of the active cursor.
:Category Cursors

:function GetActiveSynthInfo
:Synopsis Returns information about the active synthesizer.
:Description This function retrieves the active synthesizer's short name, long name and driver.
:Returns Int TRUE if synth information was retrieved, FALSE otherwise.
:Param String/byRef/sShortName the short name of the synth as defined in SynthNShortName in JFW.ini.
:Param String/byRef/sLongName the long name of the synth as defined in SynthNLongName in JFW.ini.
:Param String/byRef/sDriver the driver name of the synth as defined in SynthNDriver in JFW.ini.
:Category Voices

:function GetActiveSynthLanguage
:Synopsis Retrieves the name of the active synth language.
:Description This function gets the name of the synth language in use.
:Returns String the language name.
:Category Voices

:function GetAppFileName
:Description Determines the file name of the active application program or an active component of that program that was subsequently executed. These file names are the actual program files that are executed by Windows. The file name of the application is used when naming script files.
:Returns String Provides a filename.
:Category Application Info

:function GetAppFilePath
:Description The GetAppFilePath is used to get the fully qualified path name of the currently running application. When used in combination with GetFileDate, the results can be used to surmise an application version.
:Returns String A string containing the fully qualified path name of the currently running application. This includes drive, directory, file name, and extension.
:Category Application Info

:function GetAppletName
:Description Retrieves the name of the applet of the requested window handle.
:Returns String The name of the applet.
:Optional
:Param Handle Window of interest.  If not included, then the current window is used.
:Category Window

:function GetAppMainWindow
:Description Determines the window handle for the Main window of the active application.
:Returns Handle Provides the window handle of the application's Main window.
:Param Handle This function starts with the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the handle for the starting window. GetCurrentWindow is often used as the parameter.
:Category Window

:function GetAppTitle
:Description This obtains the title of the active application program. To have the application title spoken, you must use this function as a parameter for the SayString function.
:Returns String  The string is the title of the application.
:Category Application Info

:function GetAuthCode
:Synopsis Obtains the first 7 characters of the authorization code.
:Description For versions of JAWS using SENTINEL_LM as the Authorization scheme, this function obtains the first 7 characters of the JAWS authorization code and returns the characters as a string.
:Returns string The first 7 characters of the authorization code, or null if the authorization code could not be obtained.
:Category FS Product Info

:function GetAuthLanguageCat
:Description A call to this function determines what languages are authorized for JAWS. The values are found in HjConst.jsh and start with the prefix AUTHCAT_.
:Returns Int value for the language category.  The possible values are found in HjConst.jsh and start with the prefix AUTHCAT_.
:Category FS Product Info

:function GetAuthScheme
:Description A call to this function determines what authorization scheme is being used by JAWS. An empty string indicates no authorization scheme was found.
:Returns String The authorization scheme currently in use. Authorization schemes are found in HjConst.jsh and start with the prefix SCHEME_.
:Category FS Product Info

:function GetAuthScriptLanguageCat
:Description This function is used by developers of JAWS scripts who are concerned with use of the dongle.  A flag is returned and execution of code can be based upon a registered language.
:Returns Int The value of the language registered in the dongle.  These are registered in HjConst.jsh with the prefix AUTHCAT_SCRIPT_.
:Category FS Product Info

:function GetBrailleCellColumn
:Description Retrieves the screen column at which the specified Braille cell is located.
:Returns Int The horizontal pixel location of the cell.
:Param Int The number of the Braille cell of interest.
:Category Braille Output

:function GetBrailleCellRow
:Description Retrieves the screen row at which the specified Braille cell is located.
:Returns Int The vertical pixel location of the cell.
:Param Int The number of the Braille cell of interest.
:Category Braille Output

:function GetBrailleRestriction
:Description Gets the restriction value for the Braille cursor.  These values are located in HjConst.jsh and start with Restrict.
:Returns Int a constant representing the current level of cursor restriction. These constants begin uncder the heading Restriction types, and can be found in hjconst.jsh. They are: RestrictNone to allow the cursor to roam the screen, RestrictAppWindowto restrict to the application window, RestrictRealWindow to restrict to the real window or RestrictWindow to restrict to the current window.
:Category Cursors

:function GetCell
:Description When in a table or spreadsheet, gets the contents of the current cell.
:Returns String  Provides the Cell of information.
:Category Tables

:function GetCellCoordinates
:Description Gets the coordinates of the current cell in a table and passes them by reference to the variables specified in the parameter list.
:Returns Int TRUE if the current cursor is positioned inside of a table.  In this case, the Row and Column  parameters will have meaningful information placed in them.
:Param Int/Column/ByRef References the  current cell column on return.
:Param Int/Row/ByRef References the  current cell row on return.
:Category Tables

:function GetCharacter
:Description Copies the character or graphic label where the active cursor is positioned. The copied text can then be used by other script functions.
:Returns String Provides a character or graphic label.
:Category Screen Text

:function GetCharacterAttributes
:Description Retrieves the text attributes of the character at the current cursor location. The returned value is a combination of the same bit fields used in FindFirstAttribute, FindNextAttribute, etc. To test for the presence of a particular attribute, use code of the form: if (GetAttributes) & ATTRIB_UNDERLINE) then....
:Returns Int The attributes of the current character.
:Category Text Format

:function GetCharacterFont
:Description Retrieves the name of the font used for the character at the current cursor location.
:Returns String The name of the font.
:Category Text Format

:function GetCharacterPoints
:Description Retrieves the point size of the character at the current cursor location.
:Returns Int The point size of the character, or 0 if the cursor is either not positioned on anything or is positioned on a graphic.
:Category Text Format

:function GetCharacterValue
:Synopsis Returns the numeric value of the character parameter.
:Description This function returns the numeric value of the character parameter.
:Returns Int the value of the character.
:Param string the character whose value is desired.
:Category Strings

:function GetCharacterValueString
:Synopsis returns a string describing the specified character value
:Description This function maybe used with SayCharacter thrice to get an appropriate string to speak describing the character. For example: Character u+627 or Character 255 plus 248 or Character 1075 etc. Flags maybe used to specify if the value should be converted to hexedecimal or left as decimal and whether or not to markup the character value portion of the string.
:Returns string if the character is successfully converted to a multibyte sequence using the specified code page then the string will contain either the hex or decimal values of the characters. If the markup flag was specified, the actual values will be marked up using the toSpell text option.
:Optional
:Param string/sChar if not supplied, the character at the active cursor is assumed
:Param int/nFlags see HJConst.jsh for supported flags (see CVF constants
:Param int/nCodePage if not specified, the active code page is assumed
:Category Strings

:function GetCharacterWidth
:Description Retrieves the width of the character or graphic at the current cursor location.
:Returns Int The width of the character or graphic, or 0 if the cursor is not positioned on anything.
:Category Text Format

:function GetChunk
:Description Obtains the chunk of information to which the active cursor is pointing. A chunk is text and graphic information that was written to the screen in a single operation. GetChunk is similar to GetField, however, the GetField function uses logic to determine the text that is to be obtained, while GetChunk simply obtains the text that was stored in the off screen model as a single unit.
:Returns String  Provides the chunk of information.
:Category Screen Text

:function GetClipboardText
:Synopsis Retrieve text from the Windows clipboard.
:Description Retrieves text from the clipboard that is in standard ANSI format.  Each line ends with a carriage return/linefeed (CR-LF) combination.
:Returns STRING The text found on the clipboard, or "" if the clipboard is empty.
:Category Clipboard

:function GetColorApproximation
:Synopsis Returns the closest color for which we have a name to the color supplied. Also provides information about how the closest color relates to the color supplied.
:Description This function takes a COLORREF and finds the closest color in our table for which we have a name. It also provides information as to whether the approximated color is lighter or darker than the color passed in.
:Returns int The color approximately the same as the one past in.
:Param int/iColor the color to approximate.
:Param int/byRef/nComparisonIndicator a positive number is returned if the approximated color is brighter than the original, 0 if it is the same or a negative number to indicate that the approximated color is darker than the original.
:Category Colors

:function GetColorAtPoint
:Description Retrieves the color at the specified location.  This is the color RGB value in such as 000000000 or 255255255.
:Returns Int The color value at the specified point.
:Param Int/nX  the column coordinate of the desired location. You can use GetCursorCol() to retrieve this value.
:Param Int/nY the row coordinate of the desired location. You can use GetCursorRow() to retrieve this value.
:Category Colors

:function GetColorBackground
:Description Retrieves the background color of the character at the current cursor location.
:Returns Int The background color value.
:Category Colors

:function GetColorField
:Description Obtains the color field at the position of the active cursor. A color field is a section of information, usually text, that has a common combination of colors. For example, the combination might be white foreground on blue background. The use of the color combination must be contiguous. GetColorField is similar to GetField. However, the function GetColorField is based on color changes, while GetField is based on attribute changes.
:Returns String The color field pointed by the active cursor.
:Category Colors

:function GetColorName
:Description Retrieves the textual name for the given color found in colors.ini.
:Returns String The name of the color, or an RGB string if a name is not provided in colors.ini.
:Param Int The color value to be used.
:Category Colors

:function GetColorText
:Description Retrieves the text color of the character at the current cursor location.
:Returns Int The text color value.
:Category Colors

:function GetColumnHeader
:Description When in a table or spreadsheet, gets the contents of the column header.
:Returns String  Provides the header of information.
:Optional
:Param Int/iMarkedHeader Include only headers that are marked in the table
:Category Tables

:function GetColumnText
:Synopsis Gets the text of a range of cells in the current column of a table.
:Description This function gets the text of a range of cells in the current column of a table. You can specify the separator string to use between data elements, whether or not to include the coordinates of the active cell immediately before that cell's data and the start and end rows to include.
:Returns String The text of the included cells.
:Optional
:Param String/lpszSeparator string to insert between cell data, defaults to a single space.
:Param String/lpszCurrentCoordinateTemplate a string defining how the coordinates of the current cell will be rendered. This string must contain two % style parameters (eg c%1r%2) which will be filled with the numeric value of the current column and row respectively. If this parameter is 0 then no coordinates will be included before the current cell.
:Param String/lpszBlankCellText the text to be displayed if the cell is blank.
:Param Int/nStartRow the starting row, defaults to the first row (1) of the table.
:Param Int/nEndRow the ending row, defaults to the last row of the table.
:Category Tables

:function GetControlAttributes
:Description This function returns an integer value indicating the attributes of the current control.
:Returns Int The control attributes, as defined in HJconst.jsh. The values returned may be one of the following; CTRL_NONE = 0, CTRL_CHECKED = 1, CTRL_UNCHECKED = 2, CTRL_GRAYED = 4, CTRL_DISABLED = 8, CTRL_SUBMENU = 16, or CTRL_PRESSED = 32.
:Category Dialog Controls

:function GetControlID
:Description Determines the Control ID for the specified child window in a dialog box. Each list box, edit field, radio button, etc. in a dialog has a unique control ID number. Child windows that contain static text all have the same control ID.
:Returns Int Provides a numeric ID for the specified dialog control, or returns 0 when a dialog box is not active.
:Param Handle This function provides information for the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide a window handle.
:Category Window

:function GetControlName
:Description Gets the name of the current control.
:Returns String The name of the control.
:Category Dialog Controls

:function GetCurrentControlID
:Description Determines the control ID of the active child window in a dialog box. Each list box, edit field, radio button, and so on, in a dialog has a unique control ID number. Child windows that contain static text all have the same control ID. This function performs the same task as GetControlID but it does not require a window handle.
:Returns Int Provides a numeric ID for the active dialog control, or returns 0 when a dialog box is not active.
:Category Window

:function GetCurrentHeading
:Synopsis Gets the text of the current heading.
:Returns String the text of the heading at the virtual cursor if any.
:Category HTML

:function GetCurrentHeadingLevel
:Synopsis Gets the level of the current heading.
:Returns Int The heading level (if the cursor is on a heading) or 0 otherwise. The heading level is 1 for h1, ... 6 for h6.
:Category HTML

:function GetCurrentItem
:Description Retrieves the 1-based index of the item in a ListView or combobox which has focus.  This function expands the functionality of lvGetFocusItem to also work for comboboxes.
:Returns Int index number of the Current item.
:Param Handle The ListView or combobox window.
:Category Dialog Controls

:function GetCurrentObject
:Description Uses MSAA to obtain the object with focus at the active cursor position.
:Returns Object The accessible object at the current cursor location.
:Param Int/IDChild ID of child.
:Category Object Model And MSAA

:function GetCurrentPlaceMarker
:Synopsis Gets the current PlaceMarker.
:Description This function returns the PlaceMarker at the position of the Virtual Cursor.  If the Virtual Cursor is not positioned on a PlaceMarker, an empty (null) string is returned.
:Returns String The current PlaceMarker.
:Category HTML

:function GetCurrentRowColumnCount
:Synopsis Returns the physical number of columns in the current table row.
:Returns Int 0 if not in a table row or the number of columns in the current row.
:Category Tables

:function GetCurrentSchemeName
:Synopsis Gets the name of the currently loaded Speech and Sound Scheme.
:Description This function returns the name of the currently loaded Speech and Sounds Scheme.
:Returns String the currently active smf file minus the extention .
:Category Speech Markup

:function GetCurrentScriptKeyName
:Description Retrieves the name of the key used to invoke the currently active script.
:Returns String The key name.
:Category Scripts

:function GetCurrentWindow
:Description Determines the window handle for the window that contains the active cursor. In contrast, the GetFocus function uses an analytic process to find the window that currently has the focus, regardless of which cursor is active.
:Returns Handle  Provides a handle for the active window.
:Category Window

:function GetCursorCol
:Description This determines the horizontal position or column where the active cursor is located. It returns an integer that can be spoken with the SayInteger script function. The value returned is based upon the number of pixels that the active cursor is from the left edge  of the screen.
:Returns Int the value of the active cursor column position.
:Category Cursors

:function GetCursorRow
:Description This determines the vertical position or row where the active cursor is located. It returns an integer that can be spoken by the SayInteger script function. The value returned is based upon the number of pixels that the active cursor is from the top of the screen.
:Returns Int the value of the active cursor row position.
:Category Cursors

:function GetCursorShape
:Description Gets the current shape of the mouse cursor.
:Returns String The shape of the current cursor. It may be one of the following values; Arrow Cursor, I beam cursor, Hour Glass, or cross hair cursor.
:Category Cursors

:function GetCustomLabelKey
:Synopsis returns the custom label key for the current object
:Description This allows scripts used in the process of creating a custom label to obtain the unique key for the current object. this key is used to map the object to the custom label.
:Returns string the key used to map the object to the custom label.
:Category Misc

:function GetCustomTutorMessage
:Synopsis Retrieves a custom tutor message to be spoken by SayTutorialHelp.
:Description Retrieves a custom tutor message to be spoken by SayTutorialHelp. Overwrite this function in applications where you want a custom tutor message to be substituted instead of the usual tutor message. This function is processed after GetFrameTutorMessage and before any of the usual tutor messages are processed.
:Returns string Null if no custom tutor message is to be spoken, otherwise the custom tutor message.:Version JAWS/7.00
:Category Help

:function GetDefaultButtonName
:Description Identifies the default button in a dialog box. This is the button that will be chosen when ENTER is pressed.
:Returns String Provides the name of the default dialog button.
:Category Dialogs

:function GetDefaultJCFOption
:Description Determines the value of a specified option in the default JAWS configuration file.
:Returns Int Returns the numeric Value that has been set for the specified option.
:Param Int Type the constant value that names the option that you wish to check. Constant values are listed in HJCONST.JSH, and begin with the prefix "OPT_" or "OPTBRL_." Constants beginning with "OPTBRL_" are for Braille devices.
:Category Settings

:function GetDefaultSynthInfo
:Synopsis Returns information about the default synthesizer.
:Description This function retrieves the default synthesizer's short name, long name and driver.
:Returns Int TRUE if synth information was retrieved, FALSE otherwise.
:Param String/byRef/sShortName the short name of the synth as defined in SynthNShortName in JFW.ini.
:Param String/byRef/sLongName the long name of the synth as defined in SynthNLongName in JFW.ini.
:Param String/byRef/sDriver the driver name of the synth as defined in SynthNDriver in JFW.ini.
:Category Voices

:function GetDialogPageName
:Description If the active cursor is inside a multi-page dialog, retrieves the name of the current page.
:Returns String The name of the current page.
:Category Dialogs

:function GetDialogStaticText
:Description Gets the static text in a dialog box.
:Returns String The static text found in a Dialog box.
:Category Dialogs

:function GetDocumentPath
:Synopsis returns the path for the current document
:Description This allows scripts to obtain the path or URL of the currently active document
:Returns string The path of the current document
:Category Misc

:function GetDocumentPercentage
:Synopsis Returns the position of the active cursor as a percentage of the entire document.
:Description This function returns the position of the cursor as a percentage of the entire document.
:Returns Int percentage
:Category HTML

:function GetDomainName
:Synopsis returns the domain for the current document
:Description This allows scripts to obtain the domain of the currently active document
:Returns string The domain of the current document
:Category Misc

:function GetElementDescription
:Synopsis Returns a string describing the current HTML element.
:Description This function returns the current HTML element's parameters and their values as a string suitable for speaking or posting to the Virtual Buffer.
:Returns String Description of element
:Optional
:Param Int/nAncestors the number of ancestors to include in the description, the default is 1.
:Param Int/bWantTagsOnly true if you only want the tag name(s) and not the parameters as well, default is TRUE.
:Category HTML

:function GetField
:Description Obtains the information in the field where the active cursor is pointing. A field is a section of information (usually text) that has a common attribute. Examples are; bold, underlined, italics, or strikeout. The use of the attribute must be contiguous. GetField is similar to GetChunk, however, the GetField function uses logic to determine the text that is to be obtained, while GetChunk simply obtains the text that was stored in the Off Screen Model as a unit.
:Returns String Provides a field of information.
:Category Screen Text

:function GetFileDate
:Description Used to get the last modified date of a particular file GetAppFilePath can be used to specify the path of the desired application.
:Returns Int An integer containing the last modified date in the form of yyyymmdd. For example, the integer 19970911 would specify September 11, 1997.
:Param string Enter the fully qualified path name of the desired application. GetAppFilePath can be used to get the path of the currently running application.
:Category Files

:function GetFirstChild
:Description Determines the first child window that may have been created by a specific parent window. This function is useful when you wish to move down through the stack of window handles.
:Returns Handle Provides the handle of the first child window or returns a value of 0 when a child window cannot be found.
:Param Handle This function starts with the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the handle for the starting window.
:Category Window

:function GetFirstWindow
:Description Provides the handle for the first window that is at the same logical level as a specified window handle. It is used to get to the beginning point of a series of windows.
:Returns Handle Provides the handle for the first window that is at the same logical level or returns 0 when a window is not found.
:Param Handle This function starts with the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the handle for the starting window.
:Category Window

:function GetFocus
:Description Obtains the window handle for the window that has the focus. It always seeks the PC cursor or highlighted item that has the focus. It does not take into account which cursor is active. In contrast, the GetCurrentWindow function is less sophisticated. It simply obtains the handle for the window in which the active cursor is located.
:Returns Handle Provides the window handle for the window with the focus.
:Category Window

:function GetFocusObject
:Description Uses MSAA to get the object with focus.
:Returns Object The interface to the Accessible object.
:Param Int/IDChild ID of child.
:Category Object Model And MSAA

:function GetFocusRect
:Description Gets the coordinates of a focus rectangle.
:Returns Int TRUE if the focus rectangle is successfully retrieved.
:Param Int/hWnd the handle of the window containing the focus rectangle.
:Param Int/nLeft the left edge of the focus rectangle after the function is called.
:Param Int/nRight the right edge of the focus rectangle after the function is called.
:Param Int/nTop the top edge of the focus rectangle after the function is called.
:Param Int/nBottom the bottom edge of the focus rectangle after the function is called.
:Category Window

:function GetFocusRectBottom
:Description Gets the coordinates of the bottom edge of a focus rectangle.
:Returns Int Screen coordinate of bottom edge of focus rectangle.
:Param Int Handle of window containing the focus rectangle.
:Category Window

:function GetFocusRectLeft
:Description Gets the coordinates of the left edge of a focused rectangle.
:Returns Int Screen coordinate of left edge of focus rectangle.
:Param Int Handle of window containing the focus rectangle.
:Category Window

:function GetFocusRectRight
:Description Gets the coordinates of the right edge of a focus rectangle.
:Returns Int Screen coordinate of right edge of focus rectangle.
:Param Int Handle of window containing the focus rectangle.
:Category Window

:function GetFocusRectTop
:Description Gets the coordinates of the top edge of a focus rectangle.
:Returns Int Screen coordinate of top edge of focus rectangle.
:Param Int Handle of window containing the focus rectangle.
:Category Window

:function GetFont
:Returns String
:Category Text Format

:function GetForegroundWindow
:Description Retrieves the handle to the current foreground window. This is generally the main window of the active application, but can sometimes be the handle of a dialog box. Marginally faster than GetAppMainWindow.
:Returns Handle The handle of the foreground window.
:Category Window

:function GetFormFieldIndex
:Synopsis Returns the 1-based index of the current formfield.
:Description This function returns the 1-based index of the current formfield. Note that if the ControlType optional parameter is supplied and specifies a valid WT constant, this function will return the index for that control type only.
:Returns Int the 1-based table index or 0.
:Optional
:Param int/ControlType one of the WT_ constants to match on or wt_unknown (or 0) for all. This enables a list of specific formfield types to be retrieved. Note this extra param is only available in JAWS 6.0 and higher.
:Category HTML

:function GetFrameDescription
:Description Retrieves the description of a specified frame.
:Returns String The text of the description.
:Param string The frame name of interest.
:Category Frames

:function GetFrameNameAtCursor
:Description Retrieves the name of the frame that surrounds the location of the current cursor.
:Returns String The name of the frame containing the cursor. If no such frame exists, the string is empty. An empty string can be tested for by comparing the result with .""
:Category Frames

:function GetFramePrompt
:Synopsis Returns the prompt associated with the frame specified.
:Description This function retrieves the prompt of the specified frame. If no frame is specified then the frame at the active cursor location is asumed. Note that a frame's prompt is any string or strings defined as part of any EVENT_Focus/ACTION_SayString pairs.
:Returns String the prompt.
:Optional
:Param String/sName the name of the frame whose prompt you want.
:Category Frames

:function GetFrameSynopsis
:Description Retrieves the synopsis of a specified frame.
:Returns String The text of the synopsis.
:Param string The frame name of interest.
:Category Frames

:function GetFrameTutorMessage
:Synopsis Returns the tutor message associated with the frame specified.
:Description This function retrieves the tutor message of the specified frame. If no frame is specified then the frame at the active cursor location is asumed.
:Returns String the tutor message.
:Optional
:Param String/sName the name of the frame whose tutor message you want.
:Category Frames

:function GetFromStartOfLine
:Description Retrieves text on the current line that is located to the left of the active cursor.
:Returns String
:Category Screen Text

:function GetGraphicID
:Description Gets the ID associated with the graphic under the current cursor. If this function fails, then the pointer is not positioned in a valid location on the graphic. Moving into the center of the graphic increases the success of this call.
:Returns Int The Graphic ID, or zero if GetGraphicID fails.
:Category Graphics

:function GetGroupBoxName
:Description Gets the name of the current Group box.
:Returns String The name of the Group box.
:Category Dialogs

:function GetHeadingCount
:Synopsis Gets the number of headings present on the current Web page at the specified level.
:Returns Int The number of headings present.
:Param Int/nAtLevel 0 for all headings or 1 through 6 to get the count of levels at that level. These correspond to HTML tags h1 through h6.
:Category HTML

:function GetHotKey
:Description Retrieves the first underlined character in the chunk of text on which the active cursor is positioned. This is especially useful in menus and dialog boxes where an accelerator key for a particular item has been defined and is displayed on the screen as a underlined letter in the name of the control.
:Returns String The first underlined character if one exists, otherwise an empty string.
:Optional
:Param Handle The Handle of the window for which you would like to find the hot key. If a handle is not provided, the handle of the current window  will be used.
:Category Dialog Controls

:function GetHTMLFrameCount
:Description Gets the number of HTML frames present on the current Web page or html document.
:Returns Int The number of frames present.
:Category HTML

:function GetHTMLFrameIndex
:Synopsis Returns the 1-based index of the current HTML frame.
:Description This function returns the 1-based index of the current frame. Note that invisible frames are not counted.
:Returns Int the frame index.
:Category HTML

:function GetHTMLFrameName
:Synopsis Returns the name of the current frame.
:Description This function returns the name of the current HTML frame. This is either taken from the title or if no title, the name attribute.
:Returns String the name of the frame.
:Category HTML

:function GetHTMLFrameNames
:Synopsis Returns a delimited list of visible frames currently rendered in the VPC buffer.
:Description This function returns a delimited list of visible frames currently rendered in the VPC buffer. Specify the delimiter for the list using the optional string parameter. This is used to ensure that the list of frames presented by the ins+f9 keystroke is consistent with what is in the VPC bbuffer. Note that this function is not used if the VPC cursor is not active.
:Returns String the delimited list of frame names.
:Optional
:Param String/sDelimiter The delimiter to use to separate the frame names.
:Category HTML

:function GetInputLanguage
:Description Returns the name of the active intput language.  One can add multiple input languages through Control Panel's Regional and Language Options.
:Returns String The name of the active input language.
:Category System

:function GetItemRect
:Description Gets the bounding rectangle surrounding the specified item or items. Items can be combined using the bitwise (|) operator. When two or more items are combined, the resulting rectangle enclosed each of the items.
:Returns Int TRUE if the bounding rectangle is successfully retrieved.
:Param Int/nX The x coordinate of the point where the target item exists. If nX and nY are 0, then the current item rectangle will be retrieved.
:Param Int/nY The y coordinate of the point where the target item exists. If nX and nY are 0, then the current item rectangle will be retrieved.
:Param Int/nLeft The left edge of the bounding rectangle after the function is called.
:Param Int/nRight The right edge of the bounding rectangle after the function is called.
:Param Int/nTop The top edge of the bounding rectangle after the function is called.
:Param Int/nBottom The bottom edge of the bounding rectangle after the function is called.
:Param Int/nType The item type. Can be IT_CHUNK, IT_WORD, IT_CHAR, IT_FIELD, IT_COLORFIELD, IT_PROMPT, IT_CARET, IT_BOUNDINGRECT, IT_MAGNIFIED, IT_LINE, IT_PRIOR_WORD, IT_NEXT_WORD, or IT_HIGHLIGHT. Types can be combined using the bitwise (|) operator. For example, if you want to get the rectangle that surrounds an edit control and its prompt, use IT_BOUNDINGRECT | IT_PROMPT for this parameter.
:Category Window

:function GetJAWSDirectory
:Description Retrieves the full path to the directory in which JAWS is running.
:Returns String The JAWS drive and directory without a trailing \.
:Category JAWS Program

:function GetJAWSFindText
:Description Gets the text to be located when JAWSFindNext runs.
:Returns string the text which JAWSFindNext will use when searching
:Category Screen Text

:function GetJAWSHelpDirectory
:Description Retrieves the full path to the JAWS help directory currently in use. This depends on which language is being used.
:Returns String The JAWS drive and help directory without a trailing \.
:Category JAWS Program

:function GetJAWSSettingsDirectory
:Description Retrieves the full path to the JAWS settings directory currently in use. This depends on which language is being used.
:Returns String The JAWS drive and settings directory without a trailing \.
:Category JAWS Program

:function GetJAWSUserName
:Synopsis Retrieves the name of the user currently logged into JAWS.
:Description If this instance of JAWS is not network aware, then the function returns ""
:Returns String the name of the user currently logged into JAWS.
:Category JAWS Program

:function GetJCFOption
:Description Determines the value of a specified option in the active JAWS configuration file.
:Returns Int Returns the numeric value that has been set for the specified option.
:Param Int Type the constant value that names the option that you wish to check. Constant values are listed in HJCONST.JSH, and begin with the prefix "OPT_" or "OPTBRL_." Constants beginning with "OPTBRL_" are for Braille devices.
:Category Settings

:function GetJFWLang
:Description Gets the three letter abbreviation of the JAWS Language that is currently in use.  This is the language of the resource DLLs that are loaded by JAWS.  This is not necessarily the same as the current speech synthesizer language.
:Returns String Returns a string containing the three letter abbreviation of the JAWS Language that is currently in use.
:Category JAWS Program

:function GetJFWSerialNumber
:Description Used to get the serial number of the currently running JAWS.
:Returns Int The serial number of the corrently running JAWS, or 0 if there is an error.
:Category FS Product Info

:function GetJFWSMACount
:Synopsis Returns the SMA count.
:Description This function returns the SMA count as an integer.
:Returns Int The SMA count.
:Category FS Product Info

:function GetJFWVersion
:Description Used to get the version of the currently running JAWS. Can be used to ensure that a function is only called on versions of JAWS that support it.
:Returns Int An integer of the form jjmmbbb where j represents the major version, m represents the minor version, and b represents the build number. For example, the integer 300061 would specify JFW 3.00.61.
:Category JAWS Program

:function GetKeyState
:Description Returns by reference both the up/down state of the key, and the toggle state if applicable.  NumLock, ScrollLock, and CapsLock have toggle states.
:Returns Int TRUE if the keystate was successfully returned.
:Param String/strName The name of the key whose state is to be retrieved.  A list of key names is referenced in keycodes.ini.
:Param Int/bDown/ByRef Set to true if the key is in a down state.
:Param Int/bOn/ByRef Set to true if the toggle state is on.  For example, if CapLock is in the on state, then this value will be true.
:Category Keyboard

:function GetLastBrailleRoutingKey
:Description Retrieves the position of the last routing key pressed on a Braille display.
:Returns Int The position of the Braille cell with which the routing key is associated. 1 = "cell 1", 2 = "cell 2", and so on.
:Category Braille Output

:function GetLastMSAAAlertInfo
:Synopsis retrieves the text and alert level of the last known MSAA alert
:Description This function allows the user to retrieve the text and alert level of the last MSAA alert.
:Returns int TRUE if there is alert data still in the buffer, FALSE otherwise
:Param string/byRef/sText the text of the alert
:Param int/byRef/nLevel the priority level of the alert, 1 highest, 3 lowest
:Category Object Model and MSAA

:function GetLastWindow
:Description Provides the handle for the last window that is at the same logical level as a specified window handle. It is used to get to the end point of a series of windows.
:Returns Handle Provides the handle for the last window that is at the same logical level or returns 0 when a window is not found.
:Param Handle This function starts with the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the handle for the starting window.
:Category Window

:function GetLine
:Description Copies the text from the line where the active cursor is positioned. The copied text can then be used by other script functions.
:Returns String Provides a line of text.
:Category Screen Text

:function GetLineBottom
:Description Determines the vertical pixel location of the bottom of the line containing the current cursor.
:Returns Int The pixel location of the bottom of the current line of text, or 0 if no text is found in this location.
:Category Text Format

:function GetLineCount
:Synopsis Gets the number of lines in the current document .
:Description This function returns the number of lines in the current virtual document.
:Returns Int the number of lines.
:Category Misc

:function GetLineTop
:Description Determines the vertical pixel location of the top of the tallest character of the line on which the current cursor is positioned. Since the cursor position reported by JAWS is based on the base line of characters, this function is the only way of determining how high up a line of text extends.
:Returns Int The pixel location of the top of the tallest character on the current line of text, or 0 if no text is found in this location.
:Category Text Format

:function GetLinkCount
:Synopsis Gets the number of links present on the current Web page.
:Returns Int The number of links present.
:Category HTML

:function GetListOfFormFields
:Synopsis Returns a delimited list of form fields.
:Description This function returns a delimited list of form fields currently rendered in the VPC buffer. Specify the delimiter for the list using the optional string parameter.
:Returns String the delimited list of form fields.
:Optional
:Param String/sDelimiter The delimiter to use to separate the form fields
:Param int/ControlType one of the WT_ constants to match on or wt_unknown (or 0) for all. This enables a list of specific formfield types to be retrieved. Note this extra param is only available in JAWS 6.0 and higher.
:Category HTML

:function GetListOfObjects
:Description Given a window handle, retrieves the names of all objects contained in that window.  This function is intended primarily as a tool for script developers to explore a new aplication and find out the names of objects contained therein. This info can be used in crafting scripts to use calls to GetObjectInfoByName.
:Returns String A delimited list of object names.
:Param HANDLE/hwnd The window containing the objects of interest
:Optional
:Param String/Delimiter Character to be used as the delimiter between object names.  If not provided, defaults to \007.
:Category Object Model And MSAA

:function GetListOfTables
:Synopsis Returns a delimited list of tables.
:Description This function returns a delimited list of tables currently rendered in the VPC buffer. Specify the delimiter for the list using the optional string parameter. The information for each table will be taken from its caption, Summary, (if no Caption) or text within the table. If the table doesn't have any text then the table entry will be labelled untitled N where N increases from 1 for each untitled table. This function is used in conjunction with MoveToTableByIndex and GetTableIndex to facilitate the listing of tables in a ddocument and the ability for the user to select and move directly to any of the tables listed.
:Returns String the delimited list of tables.
:Optional
:Param String/sDelimiter The delimiter to use to separate the table information for each table in the list.
:Category HTML

:function GetListOfTags
:Synopsis Returns a delimited list of elements with a specified tag.
:Description This function returns a delimited list of elements with the specified tag currently rendered in the VPC buffer. Specify the tag and the attributes you wish to be used for information about the tag. If a tag doesn't have any of the attributes in the comma delimited list, the inner text of the tag will be used if possible. Specify the delimiter for the list using the optional string parameter. The information for each table will be taken from its caption, Summary, (if no Caption) or text within the table. If the table doesn't have any text then the table entry will be labelled untitled N where N increases from 1 for each untitled table. This function is used in conjunction with MoveToTableByIndex and GetTableIndex to facilitate the listing of tables in a ddocument and the ability for the user to select and move directly to any of the tables listed.
:Returns String the delimited list of tags.
:Param string/sTag the UPPERCASE HTML tag to collect.
:Param string/sAttrList a comma delimited list of HTML  attributes to look for when gathering information about the tag.
:Optional
:Param String/sDelimiter The delimiter to use to separate the tag information for each tag in the list.
:Category HTML

:function GetLockingCode
:Synopsis Obtains the locking code.
:Description For versions of JAWS using SENTINEL_LM as the Authorization scheme, this function obtains the JAWS locking code and returns the code as a string.
:Returns string The locking code, or null if the locking code could not be obtained.
:Category FS Product Info

:function GetLotusProgramVersion
:Description This function returns the major version of Lotus Notes application. For example, if the full version of Lotus Notes 6.5.20.4091, GetLotusProgramVersion would return 6.
:Returns Int An integer specifying the major version of the Lotus Notes program.
:Param string The path of the Lotus Notes program for which you want the version. You can get the path by using GetAppFilePath.
:Category Application Info

:function GetLotusVersionInfoString
:Description GetLotusVersionInfoString gets a requested string from the version table of Lotus Notes application. If version is lower than 6, this function get the string from String table of this application.
:Returns String The requested string.
:Param string The path of the Lotus Notes program for which you want the information. You can get the path by using GetAppFilePath.
:Category Application Info

:function GetMenuMode
:Description Gets the mode of a menu, active or inactive.
:Returns Int The Menu mode returned.
:Category Menus

:function GetMenuName
:Description Gets the name of the active menu.
:Returns String The name of the active menu.
:Category Menus

:function GetNativeOMFromMSAA
:Synopsis Gets a pointer to the native Object Model of an application using MSAA.
:Description This function uses MSAA to get a pointer to the Application's native object model directly. It should be used when other methods fail and will only work for Office 2000 and above. It is particularly useful when running under Windows XP in Excel where all other methods fail. This function should be called when focused on the main work area, ie the Excel7 class window in Excel, the _wwg class window in MSWord etc.
:Returns Object a poihnter to the Application Object.
:Category Object Model and MSAA

:function GetNavModuleVersionInfo
:Description Retrieves information about the nav module responsible for the passed in window handle.
:Returns String String describing the nav module that is handling the passed in window.
:Param Handle Window of interest
:Category Window

:function GetNextWindow
:Description Provides the next window handle in a series of window handles that are all at the same logical level. It is used to move across a list of window handles.
:Returns Handle Provides the handle of the next window in the stack or returns a value of 0 when another window cannot be found.
:Param Handle This function starts with the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the handle for the starting window.
:Category Window

:function GetObject
:Description Looks in the Windows Running Object Table for an instance of an application with the specified COM class name.
:Returns Object
:Param String/ApplicationName Program to find.
:Category Object Model And MSAA

:function GetObjectAtPoint
:Description Uses MSAA to determine the object at a set of X/Y coordinates.
:Returns Object The accessible object at the given point.
:Param Int ref data.
:Param Int The x coordinate.
:Param Int The y coordinate.
:Category Object Model And MSAA

:function GetObjectContainerHelp
:Synopsis Returns the description of an MSAA object's container
:Description This function returns the AccDescription property of the container of an MSAA object if it has one.
:Returns String AccDescription property of accessible object's container.
:Category Object Model And MSAA

:function GetObjectDescription
:Description the description of the object with focus is returned. The value is returned as a string.
:Returns String the MSAA description of the object with focus.
:Optional
:Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.
:Category Object Model And MSAA

:function GetObjectFromEvent
:Synopsis retrieves an MSAA object from a window.
:Description This function retrieves the specified MSAA object from the given window. This object is generated by an event.
:Returns Object the MSAA object.
:Param Handle/hWnd the window containing the Object.
:Param Int/idObject the id of the object.
:Param Int/idChild the id of the child.
:Param Int/byRef/v.
:Category Object Model And MSAA

:function GetObjectHelp
:Synopsis Returns the description of an MSAA object.
:Description This function returns the AccDescription property of an MSAA object if it has one.
:Returns String AccDescription property of accessible object.
:Category Object Model And MSAA

:function GetObjectInfoByName
:Description Given a window handle and the name of an objectt contained in that window, retrieves information about that object.  In most cases, this information is obtained using MSAA.  Using this function is much faster than directly using MSAA functions to walk the object hierarchy to find the object of interest and then querying the object for the equivalent information. Information is returned in byRef parameters.  Not all information is available for all objects.
:Returns int TRUE if function was successful, false on failure.
:Param HANDLE/hwnd The window containing the object of interest
:Param string/ObjectName The name of the object desired
:Param int/nWhichOccurance If there is more than one object with this name, which one  is desired.  To retrieve the first occurance, pass in 1 as the value for this parameter.
:Param int/byref/nSubtype On return will contain the object's subtype code.
:Optional
:Param int/byref/nState On return will contain the object's state flags.  This will be a combination of Control Attribute identifiers defined in HJCONST.JSH.
:Param String/byRef/Value On return will contain the object's value.
:Param String/byRef/Description On return will contain the object's description.
:Param String/byRef/HotKey On return will contain the object's HotKey
:Param string/ContainerName On return will contain the name of the object that contains this object.
:Category Object Model And MSAA

:function GetObjectName
:Description If the Pc Cursor is active, the name of the object with focus is returned. Otherwise, the name of the object at the position of the active cursor is returned. The value is returned as a string.
:Returns String the name of the object at the position of the active cursor.
:Optional
:Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.
:Category Object Model And MSAA

:function getObjectNameFromEvent
:Synopsis retrieves the name of an MSAA object from a window.
:Description This function retrieves the name of the specified MSAA object from the given window. This object is generated by an event.
:Returns String Object name, help or description (searched in that order).
:Param Handle/hWnd the window containing the Object.
:Param Int/idObject the id of the object.
:Param Int/idChild the id of the child.
:Category Object Model And MSAA

:function GetObjectRect
:Synopsis Retrieves the focus rectangle surrounding the object at the position of the active cursor.
:Description Will return TRUE if the object has a focus rectangle, FALSE otherwise. This function takes four int parameters. Left, right, top and bottom. Declare, but do not initialize, the int variables for these parameters, as they are passed by reference.
:Returns Int True if a focus rectangle was found surrounding the object, false otherwise.
:Param Int/iLeft the value for the left-hand edge of the focus rectangle surrounding the object.
:Param Int/iRight the value for the right-hand edge of the focus rectangle surrounding the object.
:Param Int/iTop the value for the top edge of the focus rectangle surrounding the object.
:Param Int/iBottom the value for the bottom edge of the focus rectangle surrounding the object.
:Optional
:Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.
:Category Object Model And MSAA

:function GetObjectState
:Synopsis Returns the state of the given object.
:Description If the PC cursor is active, the state of the object with focus is returned. Otherwise, the state of the object at the position of the active cursor is returned.
:Returns String The state of the object.
:Optional
:Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.
:Category Object Model And MSAA

:function GetObjectSubtype
:Description Retrieves the subtype of the object located at the current cursor's location. Because the type is a string that differs across languages, this function should only be used when the objective is to speak the type of the object. GetObjectTypeCode should instead be used in all conditional statements because it provides a language independent solution.
:Returns String The subtype of the object at the current cursor's location.
:Category Object Model And MSAA

:function GetObjectSubTypeCode
:Description Retrieves the numeric subtype code of the object located at the current cursor's location. Constants for these type codes all begin with WT_ and are defined in HJCONST.JSH. The numeric values are the same for all languages of JAWS. Using this function in all conditional statements instead of using GetObjectType insures that these statements will function without change in multiple languages.  The subtype code is more specific, i.e. a button can have the sub type of WT_CHECKBOX.
:Returns Int The type of the object at the current cursor's location.
:Optional
:Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.
:Category Object Model And MSAA

:function GetObjectType
:Description Retrieves the type of the object located at the current cursor's location. Because the type is a string that differs across languages, this function should only be used when the objective is to speak the type of the object. GetObjectTypeCode should instead be used in all conditional statements because it provides a language independent solution.
:Returns String The type of the object at the current cursor's location.
:Category Object Model And MSAA

:function GetObjectTypeCode
:Description Retrieves the numeric type code of the object located at the current cursor's location. Constants for these type codes all begin with WT_ and are defined in HJCONST.JSH. The numeric values are the same for all languages of JAWS. Using this function in all conditional statements instead of using GetObjectType insures that these statements will function without change in multiple languages.
:Returns Int The type of the object at the current cursor's location.
:Optional
:Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.
:Category Object Model And MSAA

:function GetObjectValue
:Description If the PC cursor is active, the value of the object with focus is returned. Otherwise, the value of the object at the position of the active cursor is returned. The value is returned as a string.
:Returns String the value of the object at the position of the active cursor.
:Optional
:Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.
:Category Object Model And MSAA

:function GetOutputModeName
:Synopsis retrieves a human friendly name for an output mode
:Description This function retrieves a human friendly output mode name given an output destination. The names can be different for Speech and Braille. For instance, OT_HELP may have a speech name of Help Information while the Braille name might be hlp. this function is used primarily to retrieve an appropriate message to be shown in the Status cells of the Braille Display or prepended to a Flash message for displays with no status cells during the display of a Flash message. This makes it easier to determine where the message is coming from.
:Returns string the human friendly name for the given output mode and destination.
:Param int/iOutputType one of the OT constants from hjconst.jsh
:Param int/IDestination one of the Output Type destinations from hjconst.jsh.
:Category Misc

:function GetParagraph
:Synopsis Gets the paragraph at the cursor.
:Description This function returns the text of the paragraph at the cursor.
:Returns String The paragraph.
:Category Screen Text

:function GetParent
:Description Determines which window created a specified child window. For Example, when a dialog box pops up, it could be used to determine the window handle of the window that created the dialog box. It can be used to move up through a list of window handles in order to get to a specific window.
:Returns Handle This is the handle of the parent window.
:Param Handle  This function starts with the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the handle for the starting window.
:Category Window

:function GetPlaceMarkerCount
:Synopsis Retrieves the number of PlaceMarkers on the current page or virtual document.
:Description Returns the number of available PlaceMarkers on the active page.  It does not determine whether or not they are valid.
:Returns Int The number of PlaceMarkers found.
:Category HTML

:function GetPriorCharacter
:Description If this function returns a null string, the cursor is at the beginning of the line.
:Returns String the prior character from the cursor position.
:Category Screen Text

:function GetPriorWindow
:Description Provides the prior window handle in a series of window handles at the same logical level. It is used to move across a list of window handles.
:Returns Handle Provides the handle of the prior window in the stack or returns a value of 0 when another window cannot be found.
:Param Handle This function starts with the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the handle for the starting window.
:Category Window

:function GetProgramVersion
:Description This function returns the major version of an application. For example, if the full version was 3.00.62, Get ProgramVersion would return 3.
:Returns Int An integer specifying the major version of the specified program.
:Param string The path of the program for which you want the version. You can get the path by using GetAppFilePath.
:Category Application Info

:function GetProgressBarInfo
:Synopsis Returns the handle and the name and value by reference of the first progress bar in the current real window.
:Description This function returns the handle, the name and the value of the first progress bar in the current real window.
:Returns handle the progress bar handle if any.
:Param string/byRef/sName the prompt of the Progress Bar.
:Param string/byRef/sValue the value of the progress bar as a percentage.
:Category Dialog Controls

:function GetRealWindow
:Description Moves up through the list of window handles in search of a real window. A real window is one that has a title.
:Returns Handle Provides the handle of the real window.
:Param Handle This function starts with the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the handle for the starting window.
:Category Window

:function GetRegistryEntryDWORD
:Synopsis Gets a DWORD entry of the registry, first parameter represents root key.
:Description Use to get DWORD entries in registry.
:Returns int registry entry, no error checking.
:Param int 0=HKEY_CLASSES_ROOT, 1=HKEY_CURRENT_USER, 2=HKEY_LOCAL_MACHINE, 3=HKEY_USERS.
:Param String/byRef/Name of SubKey
:Param String/byRef/Name of Variable
:Category System

:function GetRegistryEntryString
:Synopsis Gets a string entry of the registry, first parameter represents root key.
:Description Use to get string entries in registry.
:Returns string The string of entry, otherwise an empty string.
:Param int 0=HKEY_CLASSES_ROOT, 1=HKEY_CURRENT_USER, 2=HKEY_LOCAL_MACHINE, 3=HKEY_USERS.
:Param String/byRef/Name of SubKey
:Param String/byRef/Name of Variable.
:Category System

:function GetRestriction
:Description Gets the restriction value for the current cursor.  These values are located in HjConst.jsh and start with Restrict.
:Returns Int a constant representing the current level of cursor restriction. These constants begin uncder the heading Restriction types, and can be found in hjconst.jsh. They are: RestrictNone to allow the cursor to roam the screen, RestrictAppWindowto restrict to the application window, RestrictRealWindow to restrict to the real window or RestrictWindow to restrict to the current window.
:Category Cursors

:function GetRestrictionName
:Description Says the current level of restriction for the active cursor.  All cursors besides the PC cursor can have their restriction changed.
:Returns Void
:Param Int/nRestriction The first parameter requires a constant indicating the current level of cursor restriction. The function GetRestriction can provide a constant for this value.
:Category Cursors

:function GetRichEditDocument
:Description Gets a pointer to the ITextDocument interface of the document in the specified window. This only works for windows of class RichEdit20A or RichEdit20W.  The ITextDocument Interface allows access to the object model of RichEdit documents in a similar manner to the MSWord object model.  For more details, search Microsoft Developer Network for "Text Object Model."
:Returns Object A pointer to the ITextDocument interface.
:Optional
:Param Handle/hRichEdit The handle to the window of interest.  It defaults to the window with focus.
:Category Object Model and MSAA

:function getRoleText
:Synopsis Retrieves the localized description of an MSAA role.
:Description This function retrieves the description of an MSAA role. MSAA roles can be retrieved by accessing the accRole property of an MSAA object. This function is equivalent to the GetRoleText function in the MSAA SDK.
:Returns String The text describing the role.
:Param int/sRole The role constant to describe. This should be obtained from the accRole property of an MSAA object.
:Category Object Model And MSAA

:function GetRowHeader
:Description When in a table or spreadsheet, gets the contents of the row header.
:Returns String  Provides the header of information.
:Optional
:Param Int/iMarkedHeader Include only headers that are marked in the table
:Category Tables

:function GetRowText
:Synopsis Gets the text of a range of cells on the current row of a table.
:Description This function gets the text of a range of cells on the current row of a table. You can specify the separator string to use between data elements, whether or not to include the coordinates of the active cell immediately before that cell's data and the start and end columns to include.
:Returns String The text of the included cells.
:Optional
:Param String/lpszSeparator string to insert between cell data, defaults to a single space.
:Param String/lpszCurrentCoordinateTemplate a string defining how the coordinates of the current cell will be rendered. This string must contain two % style parameters (eg c%1r%2) which will be filled with the numeric value of the current column and row respectively. If this parameter is 0 then no coordinates will be included before the current cell.
:Param String/lpszBlankCellText the text to be displayed if the cell is blank.
:Param Int/nStartCol the starting column, defaults to the first column (1) of the row.
:Param Int/nEndCol the ending column, defaults to the last column of the row.
:Category Tables

:function GetScreenEcho
:Description Obtains the current screen echo setting. The screen echo setting determines the amount of information that is to be read as the information is displayed on the desktop. The Say NonHighlighted text and Say Highlighted text functions often check the setting for screen echo before deciding how much information to speak.
:Returns Int  "ECHO_NONE" = 0, "ECHO_HIGHLIGHTED" = 1, "ECHO_ALL" = 2.
:Category Screen Text

:function GetScriptAssignedTo
:Description Looks up the name of the script assigned to the specified key.
:Returns string If the key name is assigned to a script, the name of the script to which it is assigned; null otherwise.
:Param string the key name for which the script assignment is to be determined.
:Category Script

:function GetScriptDescription
:Description Retrieves the description of a specified script.
:Returns String The text of the description.
:Param string The script name of interest.
:Category Scripts

:function GetScriptFileName
:Description Retrieves the name of a currently active default or application script file. For the application script file, this is the same as the executable file name of the application, except in those cases where the originally loaded application script file replaced itself with another one by me and of SwitchToScriptFile. Similarly, for the active default script file, this is the name specified in JFW.INI, except in those cases where the original file replaced itself by means of SwitchToScriptFile.
:Returns String The name of the script file. This name can be blank if requesting the application script file name and no application script file is loaded.
:Param Int/WantAplication True to obtain the name of the application script file, False to obtain the name of the default script file.
:Category Scripts

:function GetScriptKeyName
:Description Retrieves the name of the key attached to the specified script.
:Returns String The key name.
:Param string The name of the script.
:Category Scripts

:function GetScriptKeyNames
:Description Retrieves a \r\n delimited list of the names of all the keys that are assigned to the specified script.
:Returns String A \r\n delimited list of the names of all the keys that are assigned to the specified script.
:Param string The name of the script.
:Category Scripts

:function GetScriptSynopsis
:Description Retrieves the synopsis of a specified script.
:Returns String The text of the synopsis.
:Param string The script name of interest.
:Category Scripts

:function GetSelectedText
:Description Retrieves the currently selected text.
:Returns String Provides the selected text.
:Optional
:Param int/bWantMarkup JAWS 6.0, specify true if you want the text to contain speech markup, defaults to false if not specified.
:Category Selection

:function GetSentence
:Synopsis Gets the sentence at the cursor.
:Description This function returns the text of the sentence at the cursor.
:Returns String The sentence.
:Category Screen Text

:function GetSharedSettingsDirectory
:Description Retrieves the full path to the shared settings directory currently in use. This depends on which language is being used.
:Returns String The shared drive and settings directory without a trailing \.
:Category JAWS Program

:function GetSpellString
:Returns String
:Param String/sText
:Category Strings

:function GetSynthLanguages
:Synopsis Retrieves a list of the installed synthesiser languages .
:Description This function retrieves a list of the currently active synthesisers supported languages.
:Returns String the list of synthesiser languages.
:Param String/sDelim the delimiter to use to separate the languages in the list.
:Category Voices

:function GetSynthPitchRange
:Description Assigns the minimum and maximum possible pitch settings to the parameters taken by reference.
:Returns Void
:Param Int/Min/ByRef Type the variable to receive the minimum pitch seting for your synthesizer.
:Param Int/Max/ByRef Type the variable to receive the maximum pitch setting for your synthesizer.
:Category Voices

:function GetSynthRateRange
:Description Assigns the minimum and maximum possible rate settings to the parameters taken by reference.
:Returns Void
:Param Int/Min/ByRef Type the variable to receive the minimum rate setting for your synthesizer.
:Param Int/Max/ByRef Type the variable to receive the maximum rate setting for your synthesizer.
:Category Voices

:function GetSystemDefaultLang
:Description Gets the three letter abbreviation of the System Default language of the Windows User Interface.
:Returns String Returns a string containing the three letter abbreviation of the System Default language of the Windows User Interface.
:Category System

:function GetSystemLocaleInfo
:Synopsis Gets default System Locale specific information.
:Description this function returns Default System specific Locale information. You determine what information to return by providing an identifier defined in locale.jsh as a parameter to this function.
:Returns String the Locale specific information
:Param Int/iLocaleCType see constants defined in locale.jsh.
:Category System

:function GetSystemVolume
:Returns Int The current system volume setting.
:Category System

:function GetSystemVolumeRange
:Description Assigns the minimum and maximum possible volume settings to the parameters taken by reference.
:Returns Void
:Param Int/Min/ByRef Type the variable to receive the minimum system volume.
:Param Int/Max/ByRef Type the variable to receive the maximum system volume.
:Category System

:function GetTableCaption
:Synopsis If a table has a caption then this function returns it.
:Returns String The Table Caption
:Category Tables

:function GetTableIndex
:Synopsis Returns the 1-based index of the current table.
:Description This function returns the 1-based index of the current table. Note that invisible tables are not counted. If the cursor is not within a table, returns 0.
:Returns Int the 1-based table index or 0.
:Category HTML

:function GetTableNestingLevel
:Synopsis Returns the nesting level of the current HTML table.
:Description This function returns the nesting level of the current table. If the table is not nested then the value will be 0.
:Returns Int The nesting level (top level table has nesting level 0).
:Category Tables

:function GetTableSummary
:Synopsis If a table has a summary then this function returns it.
:Returns String The Table Summary.
:Category Tables

:function GetTagIndex
:Synopsis Returns the 1-based index of the current tag.
:Description This function returns the 1-based index of the current tag. Note that invisible tags are not counted. If the cursor is not within the specified tag, returns 0.
:Returns Int the 1-based tag index or 0.
:Param string/sTag the tag whose index is required.
:Category HTML

:function GetTestRunner
:Synopsis Used for internal testing.  Returns a handle to a test object that will be used to run automated tests.
:Returns Handle A handle to the test runner.
:Category Test

:function GetTextBetween
:Description Gets the text between two horizontal points on the screen.
:Returns String The text located between the two pixel locations.
:Param Int Screen coordinate of left edge of text to retrieve.
:Param Int Screen coordinate of right edge of text to retrieve.
:Category Screen Text

:function GetTextFromClipboard
:Synopsis Retrieves Text from Windows Clipboard.
:Description Retrieves plain text from clipboard.
:Returns String
:Category Clipboard

:function GetTextInFocusRects
:Description Retrieves the contents of all focus rectangles into a single buffer.
:Returns String The contents of the focus rectangles.
:Param Handle Handle of window.
:Category Window

:function GetTextInFrame
:Description Retrieves the text inside a specified frame.
:Returns String The frame contents.
:Param String/FrameName The name of the frame desired.
:Optional
:Param Int/bAddLineBreaks whether or not to add line breaks or to get the text as one long string.
:Category Frames

:function GetTextInRect
:Description This function gets text inside a rectangle specified by four points on the screen representing the top, bottom, left, and right boundaries of the rectangle.
:Returns String Text   inside the rectangle.
:Param Int/Left Left edge of rectangle.
:Param Int/Top top edge of rectangle.
:Param Int/Right right edge of rectangle.
:Param Int/Bottom bottom edge of rectangle.
:Optional
:Param Int/Attributes attributes of text to include. Use 0 to include all text or use a combination of attribute flags to only return text with those attributes.
:Param Int/textColor color of text to include, use IgnoreColor constant for any color.
:Param Int/backgroundColor background color of text to include.
:Param Int/bIncludeLineBreaks Whether or not to add line breaks or to get the text as one long string.
:Param Int/bGetBrailleText Whether or not to add Braille graphic labels or to get the text as it would be spoken.
:Category Window

:function GetTickCount
:Description Retrieves the amount of time that has passed since Windows was started.
:Returns Int Number of milliseconds that have passed since Windows was started.
:Category System

:function GetToEndOfLine
:Description Retrieves text on the current line that is located to the right of the current cursor.
:Returns String the text to the right of the current cursor.
:Category Screen Text

:function GetTopLevelWindow
:Description Similar to GetAppMainWindow. These two functions differ however in that GetAppMainWindow will always return the handle for the main window of the application. In contrast, the GetTopLevel function can be used within dialog boxes to return the handle of the main dialog window when there may be several child windows which are also real windows. This can be useful when the GetRealWindow function does not return the handle of the main dialog. A real window refers to a window with a title.
:Returns Handle The handle of the TopLevel window, as opposed to the AppMainWindow.
:Param Handle This function starts with the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the handle for the starting window.
:Category Window

:function GetTreeViewLevel
:Description Obtains the indent level of the item in a tree view that has focus. The root of the tree has the level 0.
:Returns Int The level of the item with focus.
:Category Dialog Controls

:function GetUserDefaultLang
:Description Gets the three letter abbreviation of the Default language of the Windows User Interface for the user that is currently logged into the system.
:Returns String Returns a string containing the three letter abbreviation of the Default language of the Windows User Interface for the user that is currently logged into the system.
:Category System

:function GetUserLocaleInfo
:Synopsis Gets User Locale specific information.
:Description this function returns User specific Locale information. You determine what information to return by providing an identifier defined in locale.jsh as a parameter to this function.
:Returns String the Locale specific information..
:Param Int/iLocaleCType see constants defined in locale.jsh.
:Category System

:function GetUserSettingsDirectory
:Description Retrieves the full path to the user settings directory currently in use. This depends on which language is being used.
:Returns String The user drive and settings directory without a trailing \.
:Category JAWS Program

:function GetVerbosity
:Description Used to obtain the current setting for verbosity. It returns a constant value to indicate the setting: Beginner means speak maximum information, Intermediate means speak a moderate amount of information, and Advanced means speak a minimum amount of information. These values can be used in If...Then...Else...statements.
:Returns Int "BEGINNER" = 0, "INTERMEDIATE" = 1, "ADVANCED" = 2.
:Category Settings

:function GetVersionInfoString
:Description GetVersionInfoString gets a requested string from the version table of an application.
:Returns String The requested string.
:Param string The path of the program for which you want the information. You can get the path by using GetAppFilePath.
:Param string Identifier string specifying which piece of information is requested. Identifiers must be contained within quotation marks. You can use the following identifiers: Comments, CompanyName, FileDescription, FileVersion, InternalName, LegalCopyright, LegalTrademarks, OriginalFilename, PrivateBuild, ProductName, ProductVersion, or SpecialBuild.
:Category Application Info

:function GetVoiceParameters
:Description Retrieves the parameters for the voice context you specify.  These include Volume, Rate, Pitch, Punctuation and person.
:Returns Void
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Param Int/volume/ByRef Type the variable to receive the voice volume setting.
:Param Int/Rate/ByRef Type the variable to receive the voice rate setting.
:Param Int/Pitch/ByRef Type the variable to receive the voice pitch setting.
:Param Int/Punctuation/ByRef Type the variable to receive the voice punctuation setting.
:Param String/Person/ByRef Type the variable to receive the voice person setting.
:Category Voices

:function GetVoicePerson
:Description Using the Voice Context name, the person for the active voice is returned.
:Returns String The current voice person setting.
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Optional
:Param Int/iSaveWhere This parameter is optional.  Setting a value of true, saves the voice settings to the application file.  The default is to save it in the default.jcf.
:Category Voices

:function GetVoicePitch
:Description Using the Voice Context name, the pitch setting for the active voice is returned.
:Returns Int The current voice pitch setting.
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Optional
:Param Int/iSaveWhere This parameter is optional.  Setting a value of true, saves the voice settings to the application file.  The default is to save it in the default.jcf.
:Category Voices

:function GetVoicePunctuation
:Description Using the Voice Context name, the punctuation setting for the active voice is returned.
:Returns Int The current voice punctuation setting.
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Optional
:Param Int/iSaveWhere This parameter is optional.  Setting a value of true, saves the voice settings to the application file.  The default is to save it in the default.jcf.
:Category Voices

:function GetVoiceRate
:Description Using the Voice Context name, the rate setting for the active voice is returned.
:Returns Int The current voice rate setting.
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Optional
:Param Int/iSaveWhere This parameter is optional.  Setting a value of true, saves the voice settings to the application file.  The default is to save it in the default.jcf.
:Category Voices

:function GetVoiceVolume
:Description Using the Voice Context name, the volume setting for the active voice is returned.
:Returns Int The current voice volume setting.
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Optional
:Param Int/iSaveWhere This parameter is optional.  Setting a value of true, saves the voice settings to the application file.  The default is to save it in the default.jcf.
:Category Voices

:function GetVoiceVolumeRange
:Description Assigns the minimum and maximum possible volume settings to the parameters taken by reference.
:Returns Void
:Param Int/Min/ByRef Type the variable to receive the minimum volume setting for your synthesizer.
:Param Int/Max/ByRef Type the variable to receive the maximum volume setting for your synthesizer.
:Category Voices

:function GetWindowAtPoint
:Description Gets the handle of the window at the specified point. For example, this function can be used with MouseMovedEvent to get the handle of the window containing the mouse pointer.
:Returns Handle The handle of the window at the point specified by x and y. The value is 0 if a valid window handle is not found.
:Param Int/x The horizontal (x) value of the point.
:Param Int/y The vertical (y) value of the point.
:Category Window

:function GetWindowBottom
:Description Gets the screen coordinate for the bottom of the window of interest.
:Returns Int Screen coordinate of bottom edge of window.
:Param Int Handle of window of interest.
:Category Window

:function GetWindowClass
:Description This obtains the window class name of a window. Most standard windows (non SDM windows) have a window class name and a window type name. Window class names are generally unique to specific windows in specific applications.
:Returns String  The string is the class name.
:Param Handle This function provides information for the window that is identified by a window handle. Type a variable name or choose a script function to provide the window handle it needs.
:Category Window

:function GetWindowHierarchyX
:Synopsis Gets the hierarchical position of the supplied window relative to the first window at the same level.
:Description This function gets the hierarchical position of the supplied window relative to the first window at the same level, ie it counts the windows at the same level and returns this window's position.
:Returns Int The position of the window relative to the first at the same level.
:Param Handle/hWnd handle of starting window.
:Category Window

:function GetWindowHierarchyY
:Synopsis Gets the hierarchical position of the supplied window relative to the window's first existing ancestor.
:Description This function gets the hierarchical position of the supplied window relative to the first ancestor for this window, ie counts the parent, grandparent, great grandparent etc.
:Returns Int The position of the window relative to the first existing ancestor.
:Param Handle/hWnd handle of starting window.
:Category Window

:function GetWindowLeft
:Description Gets the screen coordinate for the left of the window of interest.
:Returns Int Screen coordinate of left edge of window.
:Param Int Handle of window of interest.
:Category Window

:function GetWindowName
:Description Obtains the title of the specified window, such as for a main application window, dialog box, or document window. Not all windows have titles.
:Returns String Provides the title of the window when a title is present. When a title is not present, the null value of "" is returned.
:Param Handle Type the name of a variable or choose a script function to specify the window handle title that is desired.
:Category Window

:function GetWindowRect
:Description Gets the bounding rectangle of the window whose handle is specified.
:Returns Int TRUE if the bounding rectangle is successfully retrieved.
:Param Handle/hwnd The handle of the window for which the rectangle is requested. GetFocus can be used to return this value.
:Param Int/nLeft The left edge of the bounding rectangle after the function is called.
:Param Int/nRight The right edge of the bounding rectangle after the function is called.
:Param Int/nTop The top edge of the bounding rectangle after the function is called.
:Param Int/nBottom The bottom edge of the bounding rectangle after the function is called.
:Category Window

:function GetWindowRight
:Description Gets the screen coordinate for the right of the window of interest.
:Returns Int Screen coordinate of right edge of window.
:Param Int Handle of window of interest.
:Category Window

:function GetWindowsOS
:Description Provides information about which operating system is being used.
:Returns Int One of the constants OS_WIN95 or OS_WIN_NT. These constants are defined in HJCONST.jsh.
:Category System

:function GetWindowsSystemDirectory
:Synopsis Returns the current Windows System directory.
:Description Returns the path to the Windows System directory as a string.
:Returns String the path to the current Windows System Directory.
:Category System

:function GetWindowStyleBits
:Synopsis Returns the Window style bit flags.
:Description This function returns the window style bit flags. See the WS constants in the standard winUser.h.
:Returns Int the bit flags.
:Param Handle/hWnd the window whose style bits are required.
:Category Window

:function GetWindowSubtypeCode
:Description Obtains the window subtype code number for the specified window. This function is similar to GetWindowTypeCode, but attempts to be even more specific. If no more specific information is available, returns the same thing as GetWindowTypeCode. For example, Calling GetWindowTypeCode using the window handle for the Taskbar would return WT_TABCONTROL, and calling GetWindowSubtypeCode would return WT_TASKBAR, a more specific type of tab control. See the documentation for GetWindowTypeCode for more details.
:Returns Int The window subtype number for the specified window.
:Param Handle This function provides information for the window that is identified by a window handle. Type a variable name or choose a script function to provide the window handle it needs.
:Category Window

:function GetWindowText
:Description Retrieves the text contained in a window.
:Returns String The retrieved text.
:Param Handle/hwnd The handle of the window containing the requested text. GetFocus can be used to return this value.
:Param Int/bHighlightOnly TRUE if only highlighted text is requested, otherwise FALSE.
:Category Window

:function GetWindowTextEx
:Description Retrieves the text contained in a window. It functions similar to GetWindowText but allows you to select whether or not to retrieve the text in all child windows.
:Returns String The retrieved text.
:Param Handle/hwnd The handle of the window containing the requested text. GetFocus can be used to return this value.
:Param Int/bHighlightOnly Enter TRUE if only highlighted text is requested, otherwise FALSE.
:Param Int/bIncludeChildren Enter TRUE if text within child windows should be included, FALSE if only text from this window should be retrieved.
:Category Window

:function GetWindowTop
:Description Gets the screen coordinate for the top of the window of interest.
:Returns Int Screen coordinate of top edge of window.
:Param Int Handle of window of interest.
:Category Window

:function GetWindowType
:Description Obtains the window type name of a window. Most standard windows (non SDM windows) have a window type name and a window class name. Examples of window types are: static text, edit field, check box, radio button, etc. The same window type names are commonly used in many different Windows applications.
:Returns String The string is the window type.
:Param Handle This function provides information for the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the window handle it needs.
:Category Window

:function GetWindowTypeCode
:Description Obtains the window type code number for the specified window. These numbers are the same for English and non-English versions of JAWS. Many window type numbers have constant values assigned to them in the file HJCONST.JSH. The GetWindowType function returns these constants instead of the window type number.
:Returns Int The window type number for the specified window.
:Param Handle Type a variable name or choose a script function to provide the window handle it needs.
:Category Window

:function GetWord
:Description Copies the word where the active cursor is positioned. The copied text can then be used by other script functions
:Returns String Provides a word.
:Category Screen Text

:function GotoLineNumber
:Synopsis Moves the cursor to the specified line number in virtual documents.
:Description this function moves the cursor to the specified line number in a virtual document.
:Returns Int true if the line was successfully moved to, false otherwise.
:Param Int/nLine the line number (starting at 1).
:Category Navigation

:function GraphicsEnumerate
:Description For every graphic contained within a specific window, calls a specified function, passing it the coordinates of the graphic.
:Returns Int Count of the number of graphics enumerated.
:Param Handle/hwnd The handle of the window containing the graphics of interest.
:Param String/strFunctionName The name of the function to be called with information about each graphic in the window.  This function should return TRUE if the enumeration is allowed to continue, FALSE if the enumeration should stop immediately.  This function should be defined as: int Function SomeName(int nLeft,int nTop,int nRight,int nBottom).
:Category Graphics

:function GraphicsLabeler
:Description Starts the graphics labeler utility that is used to label graphic symbols. The JAWS cursor must be positioned on the graphic symbol that you wish to label before this function is used.
:Category Graphics

:function GraphicsListHelper
:Description Assists the GraphicsList function in creating a string delimitted list of graphics labels.
:Category Graphics

:function HasFocusRect
:Description Determines if the specified window has a focus rectangle (Not implemented currently).
:Returns Int  "True" or "False", 1 or 0.
:Param Handle Handle of window to check
:Category Window

:function HasTitleBar
:Description Determines whether a window has a title bar. If the window has a title bar, then the function returns a constant value of TRUE. If the window does not have a title bar, then a constant value of FALSE is returned. Windows that typically have title bars are dialog boxes and main application windows.
:Returns Int "TRUE" = 1, "FALSE" = 0.
:Param Handle This function examines the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the window handle it needs.
:Category Window

:function HiWord
:Synopsis Obtains the hi-order 16-bits of a number.
:Returns int the high-order 16-bits of the number.
:Param int/number a 32-bit number which for the purposes of this function is always treated as unsigned.
:Category Misc

:function IE4GetCurrentDocument
:Synopsis Returns an object that represents the HTML document in a given browser window.
:Description The document object can be used to retrieve information about the document, to examine and modify the HTML elements and text within the document, and to process events. This function obtains the document object of the document in the current window.
:Returns Object An object that represents the HTML document in a given browser window.
:Category Object Model And MSAA

:function IE4GetFocus
:Description Returns the index of the focus object in Internet Explorer in the context of the entire collection of objects in the current document object.
:Returns Int The value indicating the index of the focus object in Internet Explorer.
:Category HTML

:function IEGetCurrentDocument
:Description This function returns an object that represents the HTML document in a given browser window. The document object can be used to retrieve information about the document, to examine and modify the HTML elements and text within the document, and to process events. This function obtains the document object of the document in the current window.
:Returns Object An object that represents the HTML document in a given browser window.
:Category HTML

:function IEGetFocus
:Description Returns the index of the focus object in Internet Explorer in the context of the entire collection of objects in the current document object
:Returns Int The value indicating the index of the focus object in Internet Explorer.
:Category HTML

:function IEGetUnrestrictedWindow
:Returns Object Window with full read access.
:Param object/FrameWindow
:Category HTML

:function IEReformatBody
:Synopsis Used to reformat documents displayed in Internet Explorer_Server Windows.
:Description Used to reformat an internet Web page that is composed of many graphics and multiple columns and / or frames. It reformats the Web page by converting to a single column of text. The reformatted Web page contains no graphics. However, if the graphic was related to a hyperlink, that hyperlink is included in the reformatted document. It then displays the reformatted document in the active window.
:Returns Int Returns 1 if the reformatting was successful, returns 0 otherwise.
:Param Handle/hndIESrvWindow The window handle of the Internet Explorer_Server Window
:Category HTML

:function If
:Description The If operator marks the beginning of an If...Then...Else... statement. A fully formulated statement includes: If...Then...Else...EndIf. The script functions that appear between the If and the Then are used to evaluate whether a certain condition is present. For example, can a certain graphics character be found in the active window? Every statement must include If...Then...EndIf. The Else is optional.
:Category Control Flow

:function IMEGetCharAtCursor
:Synopsis Retrieves the character under the cursor in the IME composition buffer.
:Returns String
:Category IME

:function IMEGetCompositionString
:Synopsis Retrieves the contents of the string being composed in the IME.
:Returns String
:Category IME

:function ImeGetConversionStatus
:Synopsis Gets the IME status
:Description Gets the IME status for the window that currently has focus.
:Returns Int Returns and integer value that indicates the current conversion mode of the Input Method Editor.  The possible return values are as follows: imeCModeUnknown (=0), imeCModeInactive (=1), imeCModeOff (=2), imeCModeAlphaHalf (=3), imeCModeAlphaFull (=4), imeCModeKatakanaHalf (=5), imeCModeKatakanaFull (=6), imeCModeHiraganaHalf (=7), and imeCModeHiraganaFull (=8).
:Optional
:Param Int/bRomanMode/ByRef An integer that is used to specify the current state of the Roman Mode Flag for the IME associated with the focused window.  This value is set to be equal to 0 if the Roman Mode Flag is not set and 1 if the Roman Mode Flag is set.  See the documentation on ImmGetConversionStatus and the IME Conversion Mode Values in Microsoft's MSDN Library for more information.
:Param Int/iConversionMode/ByRef 	An integer that is used to specify the current conversion mode of the IME associated with the focused window.  This is the unparsed value that is obtained from the Win32 API function ImmGetConversionStatus.  See the documentation on ImmGetConversionStatus and the IME Conversion Mode Values in Microsoft's MSDN Library for more information.
:Param Int/iSentenceMode/ByRef  An integer that is used to specify the current sentence mode of the IME associated with the given window.  This is the unparsed value that is obtained from the Win32 API function ImmGetConversionStatus.  See the documentation on ImmGetConversionStatus and the IME Conversion Mode Values in Microsoft's MSDN Library for more information.
:Category IME

:function ImeGetDescription
:Returns String  Name of the active IME for this window if there is one, otherwise the name of the keyboard layout being used.
:Param Handle/hWnd Which window to check.
:Category IME

:function ImeGetGuideLine
:Description Gets Ime error message.
:Returns String
:Param Handle/Window The window associated with the Ime of interest.
:Category IME

:function ImeIsActive
:Description Determines whether or not an Ime is associated with the passed window handle.
:Returns Int True if an Ime is associated, False otherwise.
:Param Handle/window  Window to check
:Category IME

:function IndicateControlState
:Synopsis Identifies the scontrol state using the Speech Markup rules.
:Description Allows your custom scripts to take advantage of the scheme the user has set up.
:Returns Void
:Param Int/iType Enter the JFW Subtype Code for which this applies.  See WT_ constants in HjConst.jsh.
:Param int nState Either use GetControlAttributes function or one of the CTRL_ constants from HjConst.jsh if you need to specify the state yourself.
:Optional
:Param String/sOptionalText If for some reason, you need to have different text spoken you can use this parameter to enter text to be spoken.  It will be marked up as any other text would be.
:Category Speech Markup

:function IndicateControlType
:Synopsis Indicates the control type using Speech Markup.
:Description Pass the correct control type you want to be spoken for the window or control to speak.  This will honor the speech markup.
:Returns Void
:Param Int/iType Enter the type of control to be spoken.
:Optional
:Param string sControlName Enter the name of the control to be spoken, if you have a custom name for this control.  This would be true if the wrong name is spoken, or perhaps none at all, and you are customizing this control to speak.  An example would be an edit that just says Edit without the control's name.
:Param String/ControlText Enter the text or value of the control to be spoken, if it doesn't happen already.  Most edits, lists, etc. already do it, but if you need to change this here's where.
:Category Speech Markup

:function InHJDialog
:Description Checks to see if one of the dialog boxes generated by JFW is active.  These include JAWSFind, GraphicsLabeler, DlgSelectItemInList, and DlgSysTray.
:Returns Int TRUE if a dialog is active, FALSE otherwise.
:Category User Interaction

:function IniFlush
:Description Flushes all previous writes by IniWriteInteger or IniWriteString specified for the file indicated by strFile. Not flushing will not guarantee that the newly written will be available for subsequent reading functions.
:Returns Int FALSE is always returned regardless if flushing is successful for not.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniFlushEx
:Description Flushes all previous writes by IniWriteInteger or IniWriteString specified for the file indicated by strFile. Not flushing will not guarantee that the newly written will be available for subsequent reading functions.
:Returns Int FALSE is always returned regardless if flushing is successful for not.
:Param Int/iLocationCode Determines the directory where the file is located.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniReadInteger
:Description Reads an integer value from an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns Int The retrieved value or the default value if the key does not exist in the given section.
:Param String/strSection The name of the section containing the desired key value.  This value must either be a variable or contained in quotes.
:Param String/strKey The name of the key whose value is to be retrieved.  This value must either be a variable or contained in quotes.
:Param Int/nDefault The value that will be returned if the key cannot be retrieved.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniReadIntegerEx
:Description Reads an integer value from an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns Int The retrieved value or the default value if the key does not exist in the given section.
:Param String/strSection The name of the section containing the desired key value.  This value must either be a variable or contained in quotes.
:Param String/strKey The name of the key whose value is to be retrieved.  This value must either be a variable or contained in quotes.
:Param Int/nDefault The value that will be returned if the key cannot be retrieved.
:Param Int/iLocationCode Determines the directory where the file is located.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniReadSectionKeys
:Description Retrieves the keys from a section in an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns String The key names from the given section as a list of strings delimited by the '|' character.  If there no keys, an empty string is returned.
:Param String/strSection The name of the section containing the desired key value.  This value must either be a variable or contained in quotes.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniReadSectionKeysEx
:Description Retrieves the keys from a section in an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns String The key names from the given section as a list of strings delimited by the '|' character.  If there no keys, an empty string is returned.
:Param String/strSection The name of the section containing the desired key value.  This value must either be a variable or contained in quotes.
:Param Int/iLocationCode Determines the directory where the file is located.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniReadSectionNames
:Description Retrieves the section names from an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns String The section names as a list of strings delimited by the '|' character.  If there no sections, a empty string is returned.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniReadSectionNamesEx
:Description Retrieves the section names from an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns String The section names as a list of strings delimited by the '|' character.  If there no sections, a empty string is returned.
:Param Int/iLocationCode Determines the directory where the file is located.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniReadString
:Description Reads a string value from an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns String The retrieved value or the default value if the key does not exist in the given section.
:Param String/strSection The name of the section containing the desired key value.  This value must either be a variable or contained in quotes.
:Param String/strKey The name of the key whose value is to be retrieved.  This value must either be a variable or contained in quotes.
:Param String/strDefault The value that will be returned if the key cannot be retrieved.  This value must either be a variable or contained in quotes.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniReadStringEx
:Description Reads a string value from an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns String The retrieved value or the default value if the key does not exist in the given section.
:Param String/strSection The name of the section containing the desired key value.  This value must either be a variable or contained in quotes.
:Param String/strKey The name of the key whose value is to be retrieved.  This value must either be a variable or contained in quotes.
:Param String/strDefault The value that will be returned if the key cannot be retrieved.  This value must either be a variable or contained in quotes.
:Param Int/iLocationCode Determines the directory where the file is located.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniRemoveKey
:Description Removes a key and its value from an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns Int TRUE if the key is successfully removed, otherwise FALSE.
:Param String/strSection The name of the section from which the key and its value will be removed.  This value must either be a variable or contained in quotes.
:Param String/strKey The name of the key that will be removed.  This value must either be a variable or contained in quotes.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Optional
:Param Int/bFlush Optional parameter. Starting with JAWS 6.2, this flag must be set to true to flush write immediately to disk.  True will flush the current write and all previous writes specified for the file indicated by strFile. Flushing will be slower.  Not flushing will allow the write function to return quicker, but new data may not be available for subsequent read functions. Not supplying this parameter will behave as if set to true.
:Category Files

:function IniRemoveKeyEx
:Description Removes a key and its value from an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns Int TRUE if the key is successfully removed, otherwise FALSE.
:Param String/strSection The name of the section from which the key and its value will be removed.  This value must either be a variable or contained in quotes.
:Param String/strKey The name of the key that will be removed.  This value must either be a variable or contained in quotes.
:Param Int/iLocationCode Determines the directory where the file is located.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniRemoveSection
:Description Removes an entire section an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns Int TRUE if the section is successfully removed, otherwise FALSE.
:Param String/strSection The name of the section that will be removed.  This value must either be a variable or contained in quotes.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Optional
:Param Int/bFlush Optional parameter. Starting with JAWS 6.2, this flag must be set to true to flush write immediately to disk.  True will flush the current write and all previous writes specified for the file indicated by strFile. Flushing will be slower.  Not flushing will allow the write function to return quicker, but new data may not be available for subsequent read functions. Not supplying this parameter will behave as if set to true.
:Category Files

:function IniRemoveSectionEx
:Description Removes an entire section an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns Int TRUE if the section is successfully removed, otherwise FALSE.
:Param String/strSection The name of the section that will be removed.  This value must either be a variable or contained in quotes.
:Param Int/iLocationCode Determines the directory where the file is located.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Category Files

:function IniWriteInteger
:Description Writes an integer value to an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns Int The total number of characters written to the file when the write is successful. False if the value is not written successfully.  If the file, section, or key does not already exist, it will be created.
:Param String/strSection The name of the section where the key and value will be written.  This value must either be a variable or contained in quotes.
:Param String/strKey The name of the key that will hold the value.  This value must either be a variable or contained in quotes.
:Param Int/nValue The value that will be written to the given key.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Optional
:Param Int/bFlush Optional parameter. Starting with JAWS 6.0, this flag must be set to true to flush write immediately to disk.  True will flush the current write and all previous writes specified for the file indicated by strFile. Flushing will be slower.  Not flushing will allow the write function to return quicker, but new data may not be available for subsequent read functions. Not supplying this parameter will behave as if set to true.
:Category Files

:function IniWriteIntegerEx
:Description Writes an integer value to an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns Int TRUE if the value is successfully written.  If the file, section, or key does not already exist, it will be created.
:Param String/strSection The name of the section where the key and value will be written.  This value must either be a variable or contained in quotes.
:Param String/strKey The name of the key that will hold the value.  This value must either be a variable or contained in quotes.
:Param Int/nValue The value that will be written to the given key.
:Param Int/iLocationCode Determines the directory where the file is located.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Optional
:Param Int/bFlush Optional parameter. Starting with JAWS 6.0, this flag must be set to true to flush write immediately to disk.  True will flush the current write and all previous writes specified for the file indicated by strFile. Flushing will be slower.  Not flushing will allow the write function to return quicker, but new data may not be available for subsequent read functions. Not supplying this parameter will behave as if set to true.
:Category Files

:function IniWriteString
:Description Writes a string value to an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns Int The total number of characters written to the file when the write is successful. False if the value is not written successfully. If the file, section, or key does not already exist, it will be created.
:Param String/strSection The name of the section where the key and value will be written.  This value must either be a variable or contained in quotes.
:Param String/strKey The name of the key that will hold the value.  This value must either be a variable or contained in quotes.
:Param String/strValue The value that will be written to the given key. This value must either be a variable or contained in quotes.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Optional
:Param Int/bFlush Optional parameter. Starting with JAWS 6.0, this flag must be set to true to flush write immediately to disk.  True will flush the current write and all previous writes specified for the file indicated by strFile. Flushing will be slower.  Not flushing will allow the write function to return quicker, but new data may not be available for subsequent read functions. Not supplying this parameter will behave as if set to true.
:Category Files

:function IniWriteStringEx
:Description Writes a string value to an ini style file.  An ini style file is a file containing sections of keys with their values.
:Returns Int TRUE if the value is successfully written.  If the file, section, or key does not already exist, it will be created.
:Param String/strSection The name of the section where the key and value will be written.  This value must either be a variable or contained in quotes.
:Param String/strKey The name of the key that will hold the value.  This value must either be a variable or contained in quotes.
:Param String/strValue The value that will be written to the given key. This value must either be a variable or contained in quotes.
:Param Int/iLocationCode Determines the directory where the file is located.
:Param String/strFile The path to the ini style file.  This value must either be a variable or contained in quotes.  If a directory is not specified, it will write the file under the <JFW>\Settings directory.
:Optional
:Param Int/bFlush Optional parameter. Starting with JAWS 6.0, this flag must be set to true to flush write immediately to disk.  True will flush the current write and all previous writes specified for the file indicated by strFile. Flushing will be slower.  Not flushing will allow the write function to return quicker, but new data may not be available for subsequent read functions. Not supplying this parameter will behave as if set to true.
:Category Files

:function InList
:Synopsis determines whether the active cursor is within a List.
:Description Note this function is currently only implemented to return TRUE in an HTML list.
:Returns Int True if in a list, false otherwise.
:Category HTML

:function InputBox
:Synopsis Displays a dialog box containing an edit field in which you can enter information.
:Description This function displays a simple dialog box containing four controls.  One control is an edit box in which you can enter information.  Another control is a Static Text window containing the prompt of the edit box.  The other two controls are the OK and Cancel buttons.  If you enter text into the Edit box and press the OK button, the text you typed in the Edit box is returned to the calling function by way of the third variable of the function, which is a string variable that is passed by reference to the calling function.
:Returns Int Returns 1 if the OK button was pressed.  Returns 0 if the cancel button was pressed.
:Param String/strMsg The text of the message that you would like to be displayed in the prompt of the Edit Box.
:Param String/strTitle The text of the Dialog Box's title.
:Param String/strInputText/ByRef This parameter is passed to the calling funcction or script by reference.  If you type text in the Edit box and press the OK button, this parameter returns the text that you typed to JFW.  If you do not enter text into the Edit box or you press the Cancel button, this parameter contains a NULL string,
:Category User Interaction

:function InTable
:Description Determines whether or not the active cursor is inside of a table.
:Returns Int TRUE if in a table, FALSE otherwise.
:Category Tables

:function IntToString
:Description Converts an integer value to a string and returns the string value.
:Returns String The newly created string.
:Param Int The number to be converted to a string.
:Category Strings

:function InvalidateRect
:Synopsis The InvalidateRect function adds a rectangle to the specified window's update region.
:Description The InvalidateRect function adds a rectangle to the specified window's update region. The update region represents the portion of the window's client area that must be redrawn.
:Returns int If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.
:Param handle/hwnd of window.
:Param int/nLeft Rectangle left.
:Param int/nTop Rectangle top.
:Param int/nRight Rectangle right.
:Param int/nBottom Rectangle bottom.
:Category Window

:function InvisibleCursor
:Description Activates the Invisible cursor and deactivates other cursors. The mouse pointer does not move along with the Invisible cursor. The Invisible cursor can be used in situations where movements of the JAWS cursor and mouse pointer can cause the window display to change.
:Category Cursors

:function IsBrailleCursor
:Description Determines whether the Braille cursor is active. It can be used in an If...Then...Else...statement to verify the active status of a cursor.
:Returns Int "ACTIVE" = 1, "INACTIVE" = 0.
:Category Cursors

:function IsInvisibleCursor
:Description Used to determine whether the invisible cursor is active. It can be used in an If...Then...Else...statement to verify the active status of a cursor.
:Returns Int  "ACTIVE" = 1, "INACTIVE" = 0.
:Category Cursors

:function IsJAWSCursor
:Description Determines whether the JAWS cursor is active. It can be used in an If...Then...Else...statement to verify the active status of a cursor.
:Returns Int  "ACTIVE" = 1, "INACTIVE" = 0.
:Category Cursors

:function IsJFWInstall
:Description Checks to see if JFW is running in Installation mode (with the /install flag).
:Returns Int TRUE if in install mode, FALSE otherwise.
:Category JAWS Program

:function IsKeyWaiting
:Description Indicates if there are other keys in the buffer that need to be processed.
:Returns Int Returns TRUE if there is a key waiting to be processed, otherwise, returns FALSE.
:Category Keyboard

:function IsLastKeyRepeating
:Synopsis Determines if the last key is still being held down.
:Description This function is useful if you need to avoid running a script until the last key has actually been released . This is particularly important if the script calls into an application's object model and thus would take a long time to complete., slowing response time down.
:Returns Int True the keystroke has repeated, false means it has not repeated.
:Category Keyboard

:function IsLeftButtonDown
:Description Checks to see if the left mouse button is locked down.
:Returns Int TRUE if left button is locked, FALSE otherwise.
:Category Mouse

:function IsMSAAWindow
:Description Indicates whether or not JAWS is using MSAA to gather information about the contents of this window.
:Returns Int TRUE if MSAA is used for this window, FALSE otherwise.
:Param Handle/hWnd The window to check
:Category Object Model And MSAA

:function IsMultiPageDialog
:Description Checks to see if the active cursor is positioned inside a multi-page dialog box.
:Returns Int TRUE if this is a multipage dialog, FALSE otherwise.
:Category Dialogs

:function IsPCCursor
:Description Determines whether the PC cursor is active. It can be used in an If...Then...Else...statement to verify the active status of a cursor.
:Returns Int  "ACTIVE" = 1, "INACTIVE" = 0.
:Category Cursors

:function IsRightButtonDown
:Description Checks to see if the right mouse button is locked down.
:Returns Int TRUE if right button is locked, FALSE otherwise.
:Category Mouse

:function IsRtlChar
:Synopsis Determines if a character is a Right to Left reading character.
:Description Determines if a character is a Right to Left reading character.
:Returns int true if the character is a Right to Left reading character, false otherwise.
:Param string The character to be tested.
:Category Text Format

:function IsRtlReading
:Synopsis Determines if the text in the supplied window reads from right to left.
:Description This function Determines if the text in the supplied window reads from right to left.
:Returns int true if the window contains text which reads right to left, false otherwise.
:Param handle The handle of the window to test for Right to Left reading.
:Category Text Format

:function IsSameKey
:Description Physical keys on the keyboard can have more than one name or alias.  This function determines whether two key names are referring to the same physical key.
:Returns Int TRUE if both keys refer to the same physical key.
:Param String/strKey1 The name of the first key.
:Param String/strKey2 The name of the second key.
:Category Keyboard

:function IsSameScript
:Description Determines if the current script has been called two or more times in a row without any intervening scripts being called and with no more than 500 milliseconds between each call. Using this function allows a script to act differently depending upon the number of consecutive times it has been called. A script is called whenever a key assigned to it has been pressed.
:Returns Int The number of times the script has repeated, 0 means it has not repeated.
:Category Scripts

:function IsScript
:Description Determines if a string is the name of a script.
:Returns int True if the passed string is the name of a script, false otherwise.
:Param string The name of a script or function.
:Category Script

:function IsSpeechOff
:Description Used to determine if the synthesizer is muted.
:Returns Int TRUE if the synthesizer is muted. False if the synthesizer is not muted.
:Category Voices

:function IsUnicodeJAWS
:Synopsis determines if the build of JAWS is Unicode or ANSI.
:Description This function determines if the build of JAWS is Unicode or ANSI.
:Returns int TRUE if JAWS is a Unicode build, FALSE otherwise.
:Category JAWS Program

:function IsVirtualPCCursor
:Synopsis Tests to see if the Virtual PC cursor is enabled.
:Description Checks to see if the Virtual PC cursor is being used to navigate within the window with focus.
:Returns Int TRUE if the Virtual PC cursor is active, FALSE otherwise.
:Category Cursors

:function IsWindowDisabled
:Description Checks the status of the current window or control. Returns FALSE if the window is active; TRUE if the window is disabled.
:Returns Int TRUE if window is disabled, FALSE otherwise.
:Param Handle Handle of window to check. This can be obtained through the GetFocus or GetCurrentWindow functions.
:Category Window

:function IsWindowObscured
:Description Checks to see if this window is covered by any others and therefore cannot be entirely seen.
:Returns Int TRUE if window is at least partially covered, FALSE otherwise.
:Param Handle Handle of window to check. This can be obtained through the GetFocus or GetCurrentWindow functions.
:Category Window

:function IsWindowVisible
:Description Checks the visual status of the window. This function will return true even if the window is completely covered by other windows. See function IsWindowObscured for a way to find out if a particular window is covered. Returns TRUE if the Window is visible on the screen, FALSE if the window is not visible on the screen.
:Returns Int TRUE if window on screen, FALSE otherwise.
:Param Handle Handle of window to check. This can be obtained through the GetFocus or GetCurrentWindow functions.
:Category Window

:function IsWinNtOr95
:Synopsis Distinguishes between Windows NT and 95 and Windows 98/2k.
:Description This function returns true if the OS in use is either Windows 95 or Windows NT 4.0.
:Returns Int true or false.
:Category System

:function JavaObjectChanged
:Synopsis Event fired when a Java object changes name, value or description.
:Description Since The Java UI does not lend itself to easy scripting like other UI elements this event has been created to monitor in particular, other non-focusable object changes so that these changes may be conveyed to the user.
:Returns Void
:Param String/lpszRole Java role of object generating change notification.
:Param String/lpszName AccessibleContextInfo name.
:Param String/lpszDescription AccessibleContextInfo description.
:Param String/lpszValue AccessibleValue
:Param String/lpszStates string of all states applicable to the object.
:Category Object Model and MSAA

:function JAWSBottomOfFile
:Synopsis Moves to bottom of file.
:Description Performs standard behavior of the control+end keystroke combination.  In most cases, moves the focus to the bottom of the open file, list or document.
:Category Navigation

:function JAWSCursor
:Description This activates the JAWS cursor and deactivates other cursors.
:Category Cursors

:function JAWSEnd
:Description This performs a special version of the END keyboard command. When the PC cursor is active, the script function performs the home function for the application. When other cursors are active, the cursor moves to the last text character or graphic on the line within either the active application window or active child window (depending on the setting for cursor restriction).
:Category Navigation

:function JAWSFind
:Description Finds text on the screen by presenting a dialog for input of text, direction, and choice to search for graphic or text.
:Returns Int True if the search item was found, false otherwise.
:Optional
:Param int True if the find direction should be set to reverse by default, false otherwise.
:Category Screen Text

:function JAWSFindNext
:Description Finds text on the screen after a successful initial find search.
:Returns Int TRUE if successful, FALSE if not.
:Optional
:Param Int/bReverse set this to true to find the prior occurance.
:Category Screen Text

:function JAWSHome
:Description This performs a special version of the HOME keyboard command. When the PC cursor is active, the script function performs the home function for the application. When other cursors are active, the cursor moves to the first text character or graphics on the line within either the active application window or child window (depending on the setting for cursor restriction).
:Category Navigation

:function JAWSPageDown
:Description This performs a special version of the PAGE DOWN keyboard command. When the PC cursor is active, the script function performs the standard Page Down function for the application. When other cursors are active, the cursor moves to the bottom of the active application window or to the bottom of the active child window, depending on the setting for JAWS cursor restriction.
:Category Navigation

:function JAWSPageUp
:Description This performs a special version of the PAGE UP keyboard command. When the PC cursor is active, the script function performs the standard PAGE UP command for the application. When other cursors are active, the cursor moves to the top of the active application window or to the top of the active child window (depending on the setting for JAWS cursor restriction).
:Category Navigation

:function JAWSTopOfFile
:Synopsis Moves to top of file.
:Description Performs standard behavior of the control+home keystroke combination.  In most cases, moves the focus to the top of the open file, list or document.
:Category Navigation

:function JAWSWindow
:Description This switches the focus away from the current application and makes JAWS the active application. This is equivalent to choosing JAWS from the Windows taskbar.
:Category JAWS Program

:function LasstCell
:Description When inside a table or spreadsheet, moves the active cursor to the last cell.
:Returns Int TRUE if the cursor moved, FALSE otherwise.
:Category Tables

:function LeftMouseButton
:Description Used to simulate the clicking of the left button on a mouse. If the function is assigned to a script key and is pressed twice within one second, then this simulates a double click of the mouse button.
:Category Mouse

:function LeftMouseButtonLock
:Description Attaches the mouse pointer to an object so that the object can be dragged to a new location. This is equivalent to holding down the left mouse button and moving the mouse. The first use of the function attaches the JAWS cursor and the mouse pointer to the object. The object is moved with the arrow keys, and is dropped at the new location by using the function again.
:Returns Int  "POINTER_ATTACHED" =1, "POINTER_DETACHED" = 0.
:Category Mouse

:function LoWord
:Synopsis Obtains the low-order 16-bits of a number.
:Returns int the low-order 16-bits of the number.
:Param int/number a 32-bit number which for the purposes of this function is always treated as unsigned.
:Category Misc

:function lvGetColumnHeader
:Synopsis Returns the column header for the specified listview column.
:Description This function enables you to obtain the header for a given listview column.
:Returns string
:Param handle/ hwnd of listview.
:Param int/nCol the column of the listview whose header you want.
:Category Screen Text

:function lvGetCRC
:Synopsis Calculates a unique CRC for a listview.
:Description This function is used for listview customization. This hex value corresponds to the [Listview Options] section's keys.
:Returns string a unique hex string for a listview.
:Param handle/hListview the handle to the listview.
:Category Dialog Controls

:function lvGetFocusItem
:Description Retrieves the 1-based index of the item in a ListView which has focus.  (Superceeded by GetCurrentItem.)
:Returns Int index number of the focused item.
:Param Handle The ListView window.
:Category Dialog Controls

:function lvGetItemColumnRect
:Description Gets the bounding rectangle of the item in specific column of listview or listcontrol.
:Returns Int TRUE if the bounding rectangle is successfully retrieved.
:Param Handle/hwnd The handle of the window for which the rectangle is requested.
:Param Int/Index of column, starting at zero.
:Param Int/nLeft The left edge of the bounding rectangle after the function is called.
:Param Int/nRight The right edge of the bounding rectangle after the function is called.
:Param Int/nTop The top edge of the bounding rectangle after the function is called.
:Param Int/nBottom The bottom edge of the bounding rectangle after the function is called.
:Category Window

:function lvGetItemCount
:Description Retrieves a count of items in a ListView.  (Superceeded by GetItemCount.)
:Returns Int the count of items.
:Param Handle The ListView window
:Category Dialog Controls

:function lvGetItemRect
:Description Gets the bounding rectangle of the specified item in a listview.
:Returns Int TRUE if the bounding rectangle is successfully retrieved.
:Param Handle/hwnd The handle of the ListView of interest.
:Param Int/Item index of the item desired.
:Param Int/nLeft The left edge of the bounding rectangle after the function is called.
:Param Int/nRight The right edge of the bounding rectangle after the function is called.
:Param Int/nTop The top edge of the bounding rectangle after the function is called.
:Param Int/nBottom The bottom edge of the bounding rectangle after the function is called.
:Category Dialog Controls

:function lvGetItemState
:Description Detects the current selection state of the item within a ListView.  Refer to the return states for more information.
:Returns Int LVIS_FOCUSED = 1. The item has the focus, so it is surrounded by a standard focus rectangle. Although more than one item may be selected, only one item can have the focus. LVIS_SELECTED = 2. The item is selected. The appearance of a selected item depends on whether it has the focus and also on the system colors used for selection. LVIS_CUT = 4. The item is marked for a cut-and-paste operation.  LVIS_DROPHILITED = 8. The item is highlighted as a drag-and-drop target.
:Param Handle/hwnd window handle of the List View.
:Param Int/item 1-based index of the item.
:Category Dialog Controls

:function lvGetItemText
:Description Retrieves the text of an item in a ListView.  Does not work for Owner-Drawn items.
:Returns String The contents of the requested item.
:Param Handle to the window containing a ListView.
:Param Int 1-based index of the item in the ListView of interest.
:Param Int 1-based index of the column of interest (applies only to multicolumn ListViews).
:Category Dialog Controls

:function lvGetNumOfColumns
:Description Gets the number of columns(if any) of a list control or listview.
:Returns Int Number of columns in a list control or list view.
:Param Handle/hwnd The handle of the list control or list view.
:Category Window

:function lvGetUserDefinedItemText
:Synopsis Retrieves the customized text from a listview.
:Description If a listview has been customized to speak or be Brailled in a particular manner, this function retrieves the text of the specified item as rendered by the customization.
:Returns string the user selected column headers and column data.
:Param handle/hListview the handle to the listview.
:Param int/nItem a 1-based item whose text you want.
:Optional
:Param int/nTable use 0 for speech customization, 1 for Braille customization, if not present, assumes speech.
:Category Dialog Controls

:function lvIsCustomized
:Synopsis Determines if the listview corresponding to the hwnd parameter has been customized for speech or Braille.
:Description this function determines if the listview pointed to by the hwnd parameter has a speech or Braille customization defined for it, this includes whether there is a default customization defined as well. This function is used to determine whether or not SayHighlightedText should be used to speak a listview or whether custom code should be executed.
:Returns int true or false.
:Param handle/hListview the handle to the window.
:Optional
:Param int/nTable 0 for speech, 1 for Braille, if not present, defaults to speech.
:Category Dialog Controls

:function lvIsReportListStyle
:Description Identifies the style of list control or list view.
:Returns Int TRUE if style is Report or list, otherwise FALSE.
:Param Handle/hwnd The handle of the list control or list view.
:Category Window

:function lvSelectItem
:Description Select an item within the listview.
:Returns Int True indicates that the item was selected successfully and FALSE indicates that the action failed.
:Param Handle/hWnd Handle of list view.
:Param Int/item 1-based index of the item.
:Param Int/select 1 to select, 0 to unselect.
:Category Dialog Controls

:function lvSetFocusItem
:Description Moves focus to a specified item in a ListView.  Note that this does not bring the ListView window into focus, it simply causes a specific item within a ListView to be the focused item in that window.  (Superceeded by SetCurrentItem.)
:Returns Int TRUE if successful, FALSE otherwise.
:Param Handle The window containing a ListView.
:Param Int The 1-based index of the row in the ListView to receive focus.
:Category Dialog Controls

:function MagGetArea
:Description Used to get area mode in MAGic.
:Returns Int One of: MA_VERTICAL, MA_HORIZONTAL, MA_FULL_SCREEN, MA_OVERLAY, MA_LENS, or MA_TRLENS.
:Category MAGic

:function MagGetOption
:Synopsis Gets an option that is used by MAGic.
:Description Options that can be retrieved are listed in MagCodes.jsh.
:Returns Int -1 if the option value cannot be retrieved, otherwise the option value.
:Param Int/nCode the code of the option to be retrieved. Codes are listed in MagCodes.jsh.
:Category MAGic

:function MagResetArea
:Description Resets the color masks of both magnified and unmagnified areas. Also resets to default Area mode and Default Area window sizes.
:Returns Int TRUE if the function succeeds.
:Category MAGic

:function MagSay
:Description Speak a string of text using a specific set of speech characteristics called output modes. It is possible to use separate output modes to speak title lines, dialog controls, menu items, etc.
:Param string Type the text that is to be spoken, or specify a variable name or script function that can provide the required text string. Text strings that are typed must be enclosed within quotation marks.
:Param Int Type the constant name that represents the output mode to be used when speaking this text.  See the JFW documentation for specific uses of different output modes.  In many cases, these are specific, and can be disabled from within Configuration Manager, should the user select not to hear a specific type of information.  Examples of output modes are:  OT_HELP, OT_JAWS_MESSAGE or OT_STATUS.
:Optional
:Param Int With Desktop JAWS 5 or later, enter TRUE if your string is marked up with behaviors, e.g. you used any of the SMM functions.
:Category Strings

:function MagSendKeyEvent
:Synopsis Sends a key event to the MAGic UI for processing.
:Description If a MAGic key event is attached to a key in a key map file, then you can use this function to send the key event on to the MAGic Interface. For example, when the key is pressed to toggle magnification, the KI_MAGONOFF needs to be passed on to the MAGic user interface for processing.
:Returns Int If MAGic is not running, or nKICode is out of range, then the function will return FALSE. Otherwise, TRUE is returned.
:Param Int/nKICode The code for the key event. These codes can be found in magcodes.jsh.
:Category MAGic

:function MagSetArea
:Description Used to set area mode in MAGic.
:Returns Int TRUE if the mode was set.
:Param Int/nArea The requested mode. Can be one of MA_VERTICAL, MA_HORIZONTAL, MA_FULL_SCREEN, MA_OVERLAY, MA_LENS, or MA_TRLENS.
:Category MAGic

:function MagSetBorder
:Description Used to set the color and width of borders surrounding magnification areas.
:Returns Int TRUE if the function succeeds.
:Param Int/nColor Value from 1 to 256, specifying the one based index of the system palette color to which you want the border set.
:Param Int/nWidth Value from 1 to 25, specifying the width of the border.
:Category MAGic

:function MagSetFocus
:Description Causes MAGic to set focus. How this is accomplished is defined by the FocusType parameter.
:Returns Int The function returns 0 if the function could not be performed, otherwise it returns 1.
:Param Int/left Screen coordinate of left edge of rectangle.
:Param Int/right Screen coordinate of right edge of rectangle.
:Param Int/top Screen coordinate of top edge of rectangle.
:Param Int/bottom Screen coordinate of bottom edge of rectangle.
:Param Int/nCommand The specified focus command. Can be one of MF_OVERLAY, MF_LENS, MF_VERTICAL_SPLIT, MF_HORIZONTAL_SPLIT, MF_OVERLAY_OVER_RECT, MF_LENS_OVER_RECT, MF_TRACK_LENS_OVER_RECT, or MF_TRACK_LENS.
:Param Int/nType The type of control that is being tracked. Can be MTO_MOUSE, MTO_GENERIC, MTO_CARET, MTO_MENUS, or MTO_DIALOG. If nType is set to MTO_GENERIC, then the view will always shift to the rectangle unless tracking is turned off.
:Category MAGic

:function MagSetFocusToPoint
:Description Causes MAGic to set focus to a given point. If the point is not visible, then the screen is panned to make the point visible.
:Returns Int TRUE if MagSetFocusToPoint is successful.
:Param Int/x Horizontal (x) coordinate of the point.
:Param Int/y Vertical (y) coordinate of the point.
:Category MAGic

:function MagSetFocusToRect
:Description Causes MAGic to set focus to a given rectangle. If any point in the rectangle is not visible on the screen, the screen is panned to make that point visible.
:Param Int/nLeft The left edge of the rectangle.
:Param Int/nRight The right edge of the rectangle.
:Param Int/nTop The top edge of the rectangle.
:Param Int/nBottom The bottom edge of the rectangle.
:Param Int/nType The type of control that is being tracked. Can be MTO_MOUSE, MTO_GENERIC, MTO_CARET, MTO_MENUS, or MTO_DIALOG. If nType is set to MTO_GENERIC, then view will always shift to the rectangle unless tracking is turned off.
:Category MAGic

:function MagSetMagnifiedColorMask
:Description Used to mask out a particular color in the magnified area.
:Returns Int TRUE if the function succeeds.
:Param Int/nColor Value from 0 to 255, specifying the 0 based index of the system palette color that is to be masked.
:Category MAGic

:function MagSetTrackAlignment
:Synopsis Sets the tracking alignment for MAGic mouse tracking.
:Description Tracking alignment can be set to TRACK_ALIGNMENT_EDGE, TRACK_ALIGNMENT_CENTER, TRACK_ALIGNMENT_CONTINUOUS, or TRACK_ALIGNMENT_PREDICTIVE.
:Returns Int TRUE if tracking alignment is successfully set, otherwise FALSE.
:Param Int/nAlignment One of the four alignment modes.
:Category MAGic

:function MagSetTrackingObjects
:Description Toggles ON/OFF specific tracking objects. These objects are listed under MAGic Tracking Objects in HJConst.jsh.
:Returns Int TRUE if Tracking Objects is successfully modified.
:Param Int/nFlags Identifies which specific objects are to be modified. If a tracking object is not included in nFlags, then the item's state will not be changed. You can "or" objects together using the | operator.
:Param Int/nStates Tracking objects that are included in this value are turned On. If an object is included in nFlags and in nStates, then the item will be turned On. If the item is included in nFlags, but not in nStates, the item will be turned Off.  items that are not included in nFlags are not modified.
:Category MAGic

:function MagTrackingToggle
:Description Toggles MAGic tracking ON and OFF. The MAGic interface is not updated when this function is used. When the function is used, it returns a constant value representing the new setting. ON means tracking on, and OFF means tracking off.
:Returns Int  "ON" = 1, "OFF" = 0.
:Category MAGic

:function Max
:Description Returns the maximum between two integers.  Useful when comparing variables.
:Returns Int the maximum between two integers.
:Param Int Type a variable of type int to be compared.
:Param Int Type the second variable or integer to be compared.
:Category Misc

:function MenusActive
:Description This determines whether a menu is currently active. It returns a constant value of ACTIVE to indicate a menu is active and a value of INACTIVE to indicate that it is not active. These constants can be used in If...Then...Else...statements.
:Returns Int "ACTIVE" = 1, "INACTIVE" = 0.
:Category Menus

:function MessageBox
:Description This is  used to make a message box pop up on the desktop. It can be included within an If...Then...Else...statement so that when a certain event occurs, the needed message pops up.
:Param string  This parameter must be either a text string enclosed in quotes, a variable name that contains a string value, or a script function that returns a string value.
:Category User Interaction

:function Min
:Description Returns the minimum between two integers.  Useful when comparing variables.
:Returns Int the minimum between two integers.
:Param Int Type a variable of type int to be compared.
:Param Int Type the second variable or integer to be compared.
:Category Misc

:function MinimizeAllApps
:Description Minimizes all windows on the Win95/98 or NT desktop. Same as WINDOWS KEY+M.
:Category Misc

:function MouseDown
:Description Moves the Mouse Down by the specified number of pixels.
:Returns Int TRUE if successful, FALSE if already at bottom of screen.
:Param Int Number of pixels to move.
:Category Mouse

:function MouseLeft
:Description Moves the Mouse Left by the specified number of pixels.
:Param Int Number of pixels to move.
:Category Mouse

:function MouseRight
:Description Moves the Mouse Right by the specified number of pixels.
:Returns Int TRUE if successful, FALSE if already at right of screen.
:Param Int Number of pixels to move.
:Category Mouse

:function MouseUp
:Description Moves the Mouse Up by the specified number of pixels.
:Returns Int TRUE if successful, FALSE if already at top of screen.
:Param Int Number of pixels to move.
:Category Mouse

:function MoveSliderPos
:Description Moves the position of a slider control to a different value.
:Param Handle/hWnd windows handle to the slider control that you want to change the value on.
:Param Int/iValue the PERCENTAGE to increase from the present position too.  Negative percentages decrease the slider control.
:Category Dialog Controls

:function MoveTo
:Description Moves the active cursor to the specified location on the screen. The location is specified in the form of a pixel position, where the top left hand corner of the screen is the point (0,0) and any point to the right and/or down has a positive x and y value. It is wise to be careful when using this function. This is because the pixel position of items in an application vary widely, depending upon the screen resolution on the computer that is running the application and the restored or maximized state of the application. It is always best to obtain the parameters that this function requires by searching for a particular object or string of text in the application and using GetCursorCol and GetCursorRow to store its position information in variables. Pass those variables to the function rather than a set integer value.
:Returns Int TRUE if move was successful, FALSE if one or both coordinates are off the edge of the screen.
:Param Int X-coordinate.
:Param Int Y-Coordinate.
:Category Cursors

:function MoveToControl
:Description Moves the active cursor to a specific control within a window. Although primarily useful inside dialog boxes, the function can be used in any window where child controls have unique identifiers obtained with GetControlID. It can also be used in SDM windows with the identifiers obtained using SDMGetFirstControl, SDMGetLastControl, SDMGetFocus, and so on. If the PC cursor is on when this function is called, the JAWS cursor is turned on automatically. Otherwise, the active cursor is used
:Returns Int TRUE if successful, FALSE otherwise.
:Param Handle Handle of window containing the control of interest.
:Param Int ID of desired control.
:Category Dialog Controls

:function MoveToControlType
:Synopsis Moves the cursor to the next, prior, first or last instance of the specified control type.
:Description This function Moves the cursor to the next, prior, first or last instance of the specified control type.
:Returns Int true or false.
:Param Int/iSearchType one of S_TOP, S_BOTTOM, S_NEXT or S_PRIOR as defined in hjconst.jsh.
:Param Int/iControlType One of the WT_ window type constants defined in hjconst.jsh.
:Category HTML

:function MoveToElementOfDifferentType
:Synopsis Move the virtual cursor to the next or prior element different to the current.
:Description This function will move the virtual cursor to the next or prior element different to the current. Pass in True to move in a reverse direction or nothing or false to move forward.
:Returns Int true if the cursor was moved.
:Optional
:Param Int/bReverse true to go backward, false or leave blank to go forward.
:Category HTML

:function MoveToElementOfSameType
:Synopsis Move the virtual cursor to an occurance of the current element.
:Description This function will move the virtual cursor to another occurance of the same element. The parameter determines the direction of the move, valid direction constants are listed in hjconst.jsh and include s_top, s_bottom, s_next and s_prior. For example, if you are on the header of a list you can move to the next, prior, first or last list in the document.
:Returns Int true if another element with the same tag was located, false otherwise.
:Param Int/searchDirection one of s_top, s_bottom, s_next or s_prior as defined in hjconst.jsh.
:Category HTML

:function MoveToFormField
:Synopsis Moves the virtual cursor to  a form field.
:Description Depending on the value of SearchOption, positions to the first, last, next, or prior form field on the current web page.
:Returns Int TRUE if a form field was found, FALSE otherwise.
:Param Int/SearchOption one of S_TOP, S_BOTTOM, S_NEXT, or S_PRIOR to move to the first, last, next or prior form field respectively.
:Category HTML

:function MoveToFormFieldByIndex
:Synopsis Moves to a particular form field by index.
:Description This function moves to a specified form field on a webpage. Specify the 1-based index of the form field to move to. This is primarily used with the GetListOfFormFields function which returns a delimited string containing the prompt, type and text of all formfields.
:Returns Int true if the virtual cursor was moved to a form field, false otherwise.
:Param Int/index of form field.
:Optional
:Param int/ControlType one of the WT_ constants to match on or wt_unknown (or 0) for all. This enables a list of specific formfield types to be retrieved. Note this extra param is only available in JAWS 6.0 and higher.
:Category HTML

:function MoveToFrame
:Description Moves the active cursor to the top left corner of the specified frame. If the PC cursor is active when this function is used, then the JAWS cursor is activated and it is moved to the new position. Otherwise, the active cursor is moved.
:Returns Int  "WAS_SUCCESSFUL" = 1 (frame was found), "WAS_NOT_SUCCESSFUL" = 0 (frame was not found).
:Param string The name of a frame.
:Category Frames

:function MoveToGraphic
:Description Moves the JAWS cursor, invisible cursor, or Braille cursor in a specific direction to find a graphic symbol in the active window.
:Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.
:Param Int Type one of the constants to indicate the direction that the cursor is to move as it searches for a graphic: GRAPHIC_FIRST, GRAPHIC_NEXT, GRAPHIC_PRIOR, or GRAPHIC_LAST.
:Optional
:Param int set this to TRUE to restrict the search to the window containing the active cursor, FALSE for an unrestricted search, if not supplied, defaults to FALSE, ie unrestricted. this optional parameter is only available in JAWS 6.0
:Category Graphics

:function MoveToHeading
:Synopsis Moves the virtual cursor to  a Heading.
:Description Depending on the value of SearchOption, and nLevel, positions to the first, last, next, or prior heading on the current web page.
:Returns Int TRUE if a heading was found, FALSE otherwise.
:Param Int/SearchOption one of S_TOP, S_BOTTOM, S_NEXT, or S_PRIOR to move to the first, last, next or prior form field respectively.
:Param Int/nLevel 0 to find any heading, 1 through 6 to find a heading at levels 1 through 6.
:Category HTML

:function MoveToHTMLFrame
:Synopsis Moves to the first, last, next or prior HTML frame.
:Description This function moves to the first, last, next or prior frame in an HTML document depending on the search type parameter. See hjconst.jsh for a list of constants, these constants are prefixed with s_
:Returns Int true if the virtual cursor was moved to a frame, false otherwise.
:Param Int/SearchDirection
:Category HTML

:function MoveToHTMLFrameByIndex
:Synopsis Moves to a particular frame by index.
:Description This function moves to a specified frame on a webpage. Specify the 1-based index of the frame to move to.
:Returns Int true if the virtual cursor was moved to a frame, false otherwise.
:Param Int/index of frame
:Category HTML

:function MoveToList
:Synopsis Moves the virtual cursor to  a list.
:Description Depending on the value of SearchOption, positions to the first, last, next, or prior list on the current web page.
:Returns Int TRUE if a list was found, FALSE otherwise.
:Param Int/SearchOption one of S_TOP, S_BOTTOM, S_NEXT, or S_PRIOR to move to the first, last, next or prior list respectively.
:Category HTML

:function MoveToTable
:Synopsis Moves the virtual cursor to  a table.
:Description Depending on the value of SearchOption, positions to the first, last, next, or prior table on the current web page.
:Returns Int TRUE if a table was found, FALSE otherwise.
:Param Int/SearchOption one of S_TOP, S_BOTTOM, S_NEXT, or S_PRIOR to move to the first, last, next or prior table respectively.
:Category HTML

:function MoveToTableByIndex
:Synopsis Moves to a particular table by index.
:Description This function moves to a specified table on a webpage. Specify the 1-based index of the table to move to. This is primarily used with the GetListOfTables function which returns a delimited string containing table information for each table currently rendered in the virtual document.
:Returns Int true if the virtual cursor was moved to a table, false otherwise.
:Param Int/index of table
:Category HTML

:function MoveToTableCell
:Synopsis Moves the cursor to the specified table cell.
:Description This function moves the cursor to the specified table cell. The parameters specify the column and row to move to (in 1-based coordinates).
:Returns Int true if successful, false otherwise.
:Param Int/nCol the column number
:Param Int/nRow the row number
:Category Tables

:function MoveToTag
:Synopsis Moves the cursor to the next, prior, first or last instance of the specified tag.
:Description This function Moves the cursor to the next, prior, first or last instance of the specified tag. It is primarily useful in HTML documents.
:Returns Int true or false.
:Param Int/iSearchType one of S_TOP, S_BOTTOM, S_NEXT or S_PRIOR as defined in hjconst.jsh
:Param String/sTag the HTML or other textual tag to locate
:Category HTML

:function MoveToTagByIndex
:Synopsis Moves to a particular tag by its index.
:Description This function moves to a specified tag on a webpage. Specify the 1-based index of the particular tag to move to. This is primarily used with the GetListOfTags function which returns a delimited string containing tag information for each tag currently rendered in the virtual document.
:Returns Int true if the virtual cursor was moved to a tag, false otherwise.
:Param Int/iIndex index of table
:Param string/sTag the tag to move to
:Category HTML

:function MoveToUnvisitedLink
:Synopsis Moves to the first, last, next or prior unvisited link.
:Returns Int true if an unvisited link was found, false otherwise.
:Param Int one of s_top, s_bottom, s_next or s_prior defined in hjconst.jsh.
:Category HTML

:function MoveToVisitedLink
:Synopsis Moves to the first, last, next or prior visited link.
:Returns Int true if a visited link was found, false otherwise.
:Param Int one of s_top, s_bottom, s_next or s_prior defined in hjconst.jsh.
:Category HTML

:function MoveToWindow
:Description Moves the active cursor to the specified window. If the window contains text, then the cursor is positioned on the first character. Otherwise, it is positioned at the center of the window. If the PC cursor is active when this function is used, then the JAWS cursor is activated and it is moved to the new position.
:Returns Int  "WAS_SUCCESSFUL" = 1 (window was found), "WAS_NOT_SUCCESSFUL" = 0 (window was not found).
:Param Handle Type the name of a variable or choose a script function that indicates the window handle where the active cursor is to be moved.
:Category Window

:function MSAAGetDialogStaticText
:Synopsis Gets static text from a Dialog using MSAA.
:Description This function is useful for getting descriptive static text from dialogs which support MSAA when the dialog doesn't contain child windows for each child object.
:Returns String The dialog static text.
:Category Object Model and MSAA

:function MSOGetMenuBarObject
:Description Gets the Menu bar object in MS Office 97/2000 applications.
:Returns Object The Menu bar of the current Office application.
:Category Object Model And MSAA

:function navGetAppMainObjectID
:Description Determines the object ID for the Main object of the active application.
:Returns Handle Provides the object ID of the application's Main object.
:Param Handle  This function starts with the object that is identified by an object ID. Type the name of a variable or choose a script function that can provide the handle for the starting object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetCurrentObjectID
:Description Retrieves the Object ID of the object at the location of the active cursor.  The object ID is used in a number of functions to retrieve information about objects.
:Returns Handle the Object ID or 0 if the Object ID cannot be retrieved.
:Category Window

:function navGetFirstChildObjectID
:Description Determines the first child object of a specific parent object. This function is useful when you wish to move down through the stack of object IDs.
:Returns Handle Provides the handle of the first child object or returns a value of 0 when a child object cannot be found.
:Param Handle This function starts with the object that is identified by an object ID. Type the name of a variable or choose a script function that can provide the handle for the starting object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow will be used to provide a default handle.
:Category Window

:function navGetFirstObjectID
:Description Obtains the Object ID of the first Object in a series of objects. It can provide the object ID that is needed by other object navigation functions.
:Returns Int Provides Object ID.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetFocusObjectID
:Description Retrieves the Object ID of the object at the focus point.  The object ID is used in a number of functions to retrieve information about objects.
:Returns Handle the Object ID at the focus point, or 0 if the Object ID cannot be retrieved.
:Category Window

:function navGetLastObjectID
:Description Obtains the Object ID of the last Object in a series of objects. It can provide the object ID that is needed by other object navigation functions.
:Returns Int Provides Object ID.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetNextObjectID
:Description Provides the next Object ID in a series of Object IDs that are all at the same logical level. It is used to move across a list of control objects.
:Returns Handle Provides the Object ID of the next object in the stack or returns a value of 0 when another object cannot be found.
:Param Handle This function starts with the object that is identified by an Object ID. Type the name of a variable or choose a script function that can provide the handle for the starting object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetObjectContainerHelp
:Description Retrieves the container help string of the object with the specified parent window and Object ID. If a parent window and object ID is not defined, then the object at the active cursor is used.
:Returns String the container help string of the specified object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the Object ID for object whose information is to be retrieved. If a an object ID is not provided, navGetCurrentObjectID will be used to provide a default ID.
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetObjectHelp
:Description Retrieves the help string of the object with the specified parent window and Object ID. If a parent window and object ID is not defined, then the object at the active cursor is used.
:Returns String the help string of the specified object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the Object ID for object whose information is to be retrieved. If a an object ID is not provided, navGetCurrentObjectID will be used to provide a default ID.
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetObjectName
:Description Retrieves the name of the object with the specified parent window and Object ID. If a parent window and object ID is not defined, then the object at the active cursor is used.
:Returns String the name of the specified object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the Object ID for object whose information is to be retrieved. If a an object ID is not provided, navGetCurrentObjectID will be used to provide a default ID.
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetObjectTypeCode
:Description Retrieves the object type code of the object with the specified parent window and Object ID. If a parent window and object ID is not defined, then the object at the active cursor is used.
:Returns Int the object type code of the specified object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the Object ID for object whose information is to be retrieved. If a an object ID is not provided, navGetCurrentObjectID will be used to provide a default ID.
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetObjectTypeString
:Description Retrieves the object type string of the object with the specified parent window and Object ID. If a parent window and object ID is not defined, then the object at the active cursor is used.
:Returns String the object type string of the specified object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the Object ID for object whose information is to be retrieved. If a an object ID is not provided, navGetCurrentObjectID will be used to provide a default ID.
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetParentObjectID
:Description Determines which object is directly above the specified child object. For Example, when a dialog box pops up, it could be used to determine the window handle of the window that created the dialog box. It can be used to move up through a list of object IDs in order to get to a specific object.
:Returns Handle This is the handle of the parent object.
:Param Handle  This function starts with the object that is identified by an object ID. Type the name of a variable or choose a script function that can provide the handle for the starting object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetPrevObjectID
:Description Provides the previous Object ID in a series of Object IDs that are all at the same logical level. It is used to move across a list of control objects.
:Returns Handle Provides the Object ID of the prior object in the stack or returns a value of 0 when another object cannot be found.
:Param Handle This function starts with the object that is identified by an Object ID. Type the name of a variable or choose a script function that can provide the handle for the last object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetRealObjectID
:Description Moves up through the list of objects in search of a real object. A real object is one that has a title.
:Returns Handle Provides the object ID of the real object.
:Param Handle  This function starts with the object that is identified by an object ID. Type the name of a variable or choose a script function that can provide the handle for the starting object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navGetTopLevelObjectID
:Description Similar to navGetAppMainObjectID.  These two functions differ however in that navGetAppMainObjectID will always return the object ID for the highest level object in the application.  In contrast, navGetTopLevelObjectID can be used within dialog boxes to return the object ID of the main dialog object when there may be several child windows which are also real windows. This can be useful when the navGetRealWindowObjectID function does not return the object ID of the main dialog.  A real object refers to a object with a title.
:Returns Handle The handle of the TopLevel object, as opposed to the AppMain Object.
:Param Handle  This function starts with the object that is identified by an object ID. Type the name of a variable or choose a script function that can provide the handle for the starting object.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function navSayObjectTypeAndText
:Description Speaks the name and type of the object indicated by the function's parameters or, if called with no parameters, located at the current cursor's location. This function is similar to SayWindowTypeAndText, except that it is more specific. If a particular window contains multiple objects, this function will speak information about the one at the cursor, while SayWindowTypeAndText will speak information about the enclosing window. If the window does not contain multiple objects, then the functions operate identically. When this function is used, it marks the text it reads so that the Say Highlighted Text and Say NonHighlighted Text functions do not repeat the same information when they are triggered.
:Optional
:Param Handle Type a variable name or choose a script function that can provide the Object ID for object whose information is to be retrieved. If a an object ID is not provided, navGetCurrentObjectID will be used to provide a default ID.
:Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.
:Category Window

:function NextBrailleString
:Description When the Braille device is in string mode, it displays the next string of Braille characters that are in the queue of strings that have been received by the Braille device.
:Returns Int "WAS_SUCCESSFUL" = 1 (another string was available for display), "WAS_NOT_SUCCESSFUL" = 0 (another string was not displayed).
:Category Braille Output

:function NextCell
:Description When inside a table or spreadsheet, moves the active cursor to the same cell in the next column.
:Returns Int TRUE if the cursor moved, FALSE otherwise.
:Category Tables

:function NextCharacter
:Description This performs a special version of the RIGHT ARROW or Next Character keyboard command. When the PC cursor is active, JAWS allows the application to move the cursor. When other cursors are active, then JAWS tries to move the cursor to the next character or graphic it finds to the right of the current cursor location. To speak the character at the new location, place a SayCharacter function after the NextCharacter function. Note: Once the cursor has moved to the next character, it is not spoken.
:Category Navigation

:function NextChunk
:Description This moves the active cursor to the next chunk of text. A chunk of text is a section or block of text that is written to the screen at one time, with one function call. This would typically indicate a phrase or description that should be spoken as one unit. This is useful in reading blocks of static text, control prompts, and field names.
:Category Navigation

:function NextLine
:Description This moves the active cursor down to the next line. In many situations, Windows does not display information in perfect horizontal rows, and the cursor may not move a uniform distance each time this function is used. To speak the information immediately after the NextLine function is used, place a SayLine function after the NextLine function.
:Returns Int
:Category Navigation

:function NextNonLink
:Synopsis Positions the Virtual cursor at the next large block of nonlink text.
:Description Often useful for moving past advertisement text on a Web page.
:Category HTML

:function NextParagraph
:Description Moves the active cursor to the beginning of the next paragraph. If the PC cursor is active and the next paragraph is not already visible, then text in the window will automatically scroll to bring it into view.
:Returns Int TRUE if the next paragraph was found, FALSE otherwise.
:Category Navigation

:function NextSentence
:Description Moves the active cursor to the beginning of the next sentence. If the PC cursor is active and the next sentence is not already visible, then text in the window will automatically scroll to bring it into view.
:Returns Int TRUE if the next sentence was found, FALSE otherwise.
:Category Navigation

:function NextWord
:Description This performs a special version of the CONTROL+RIGHT ARROW or Next Word keyboard command. When the PC cursor is active, JAWS allows the application to move the cursor. When other cursors are active, then JAWS tries to move the cursor to the next word or graphic it finds to the right of the cursor's current location. To speak the word at the new cursor location, place a SayWord function after the NextWord function. Note: Once the cursor has moved to the next word, it is not spoken.
:Category Navigation

:function Not
:Description The Not operator reverses the question asked by an If...Then...Else... statement. It is placed immediately after the If in the If...Then...Else...statement. It says, "If the specified condition is not present, then perform the following actions."
:Category Control Flow

:function &&
:Description The && (ampersand ampersand) operator asks whether the first condition is true, and additionally is the second condition true.
:Category Operators

:function &
:Description The & (bitwise ampersand) operator compares each bit of its first operand to the corresponding bit of its second operand. If both bits are 1, the corresponding result bit is set to 1. Otherwise, the corresponding result bit is set to 0. The best example of how this operator can be used is in the NewTextEvent function in default.jss. There it is used for a binary comparison of two binary numerical values. The value of nAttibutes is a multiple digit binary numerical value that indicates all the attributes that apply to the buffer string. Each attribute is indicated by whether or not a certain bit in the byte is turned on. The & operator will return all values that exist in both numerical values. For example, if the value of nAttributes is 01001010 then the seventh bit in the result byte of nAttributes & ATTRIB_HIGHLIGHT will be set to one 1 (ATTRIB_HIGHLIGHT = 64 or 01000000 binary), the second bit in the result byte of nAttributes & ATTRIB_BOLD will be set to 1 (ATTRIB_BOLD = 2 or 00000010 binary), and the fourth bit in the result byte of nAttributes & ATTRIB_UNDERLINE will be set to 1 (ATTRIB_UNDERLINE = 8 or 00001000 binary) while the third bit in the result byte of nAttributes & ATTRIB_ITALIC will be set to 0 since ATTRIB_ITALIC is 4 or 00000100 binary and the third bit in the nAttributes byte is 0.
:Returns Int The result of the bitwise &.
:Category Operators

:function |
:Description The | (bitwise vertical bar) operator compares each bit of its first operand to the corresponding bit of its second operand. If either bit is 1, the corresponding result bit is set to 1. Otherwise, the corresponding result bit is set to 0. This function does a bit-by-bit comparison of two numerical values which is similar to that of the & operator. The statement 00100110 | 11000000 will return 11100110.
:Returns Int The result of the bitwise |.
:Category Operators

:function /
:Description The / slash operator is used in equations to indicate division.
:Category Operators

:function ==
:Description The == (equal equal) operator asks whether the first condition is equal to the second condition.
:Category Operators

:function >=
:Description The >= (greater than or equal to) operator asks whether the first condition is greater than or equal to the second condition.
:Category Operators

:function >
:Description The > (greater than) operator asks whether the first condition is greater than the second condition.
:Category Operators

:function <=
:Description The <= (less than or equal to) operator asks whether the first condition is less than or equal to the second condition.
:Category Operators

:function <
:Description The < (less than) operator asks whether the first condition is less than the second condition.
:Category Operators

:function -
:Description The (-) minus operator is used in equations to indicate subtraction.
:Category Operators

:function %
:Description The result of the modulus operator (%) is the remainder when the first operand is divided by the second.
:Returns Int The remainder when the first operand is divided by the second.
:Category Operators

:function *
:Description The * asterisk operator is used in equations to indicate multiplication.
:Category Operators

:function !=
:Description The !=  (exclamation mark equal to) operator asks whether the first condition is not equal to the second condition.
:Category Operators

:function ||
:Description The || vertical bar vertical bar ) operator asks whether the first condition is true, or if the second condition is true. If the first condition is true, the second condition is not evaluated. It does not matter which condition is true
:Category Operators

:function +
:Description The + (plus) operator is used in equations to indicate addition.
:Category Operators

:function OutputDebugString
:Synopsis Sends a string to the debugger for display.
:Description Sends a string to the debugger for display. The debugger may be a utility program such as DBGVIEW.EXE.
:Returns Void
:Param string String to be displayed.
:Category Utility

:function PassKeyThrough
:Description Passes a keystroke on to the active application program without activating a JAWS script. This function is used when a JAWS script key and an application keyboard command are the same. It prevents JAWS from intercepting a keystroke so that the application program can respond.
:Category Keyboard

:function PathAddExtension
:Description Adds a file extension to a path string.
:Returns String Path with specified extension appended.
:Param String/strPath Path to be modified.
:Param String/strExt Extension to be appended.
:Category JAWS Program

:function PathFindExtension
:Description Searches a path for an extension.
:Returns String Extension, or empty string ("") if not found.
:Param String/strPath Path to be searched.
:Category JAWS Program

:function PathRemoveExtension
:Description Removes the file extension from a path, if there is one.
:Returns String Path with extension removed.
:Param String/strPath Path to be modified.
:Category JAWS Program

:function PathRenameExtension
:Description Replaces the extension of a file name with a new extension. If the file name does not contain an extension, the extension will be attached to the end of the string.
:Returns String Path with specified extension appended.
:Param String/strPath Path to be modified.
:Param String/strExt Replacement extension.
:Category JAWS Program

:function Pause
:Description Stops the processing of a script so that other applications can complete tasks. When a pause function is placed in a script, JAWS yields to the time needs of other applications. Once other applications have been given the opportunity to use processing time, then JAWS resumes the script. The pause function is equivalent to using the Delay function with a value of 1. Do not place a pause command in a While loop, because this will cause the computer to freeze up.
:Category Scripts

:function PausePACMateRemote
:Synopsis Allows use of the PAC Mate during a PAC Mate Remote session
:Description While controlling a desktop session using a PAC Mate Remote session, use PausePACMateRemote to allow access to the PAC Mate without closing the active sync connection.
:Returns int TRUE if in a PAC Mate Remote session and the session is paused.
:Category Keyboard

:function PCCursor
:Description This activates the PC cursor and deactivates other cursors.
:Category Cursors

:function PlaceMarkersEnumerate
:Synopsis enumerates the placemarkers in a virtual document calling a user defined callback function for each marker.
:Description this function enumerates the placemarkers in a virtual document calling a user supplied callback function for each marker. the callback function is passed the index of the marker, the marker's name and the text at the marker. The text at the marker is optionally marked up if the second parameter to this function is true. The enumeration continues until either all markers have been visited or the callback returns false. Note this is only available in JAWS 5.00.758 or higher.
:Returns int true if the enumeration visited all markers, false if the enumeration failed or the callback returned false for any marker.
:Param string/sCallbackFunctionName the name of the function to be called for each marker. The function must be defined as func(int nIndex, string sMarkerName, sMarkerText), where func maybe any legal function name.
:Param int/bUseMarkupForMarkerText must be set to true if the text at the marker is to be passed with markup, false for no markup.
:Category Misc

:function PlaySound
:Description Plays a wave file through the computer sound system. Requires one parameter that specifies the wave filename. If a complete path is not specified, JAWS will search the path for the file.
:Param string Includes the wave filename. If a complete path is not specified, JAWS will search the path for the file. To get the \ into the path name, you must actually use two \ characters. For example, write C:\\WINNT\\Media\\chimes.wav.  This is very important. Failure to include two \ characters will cause the compiler to fail and jscript.exe to perform an illegal operation.
:Category Sounds

:function PositionInGroup
:Synopsis Returns the string usually spoken on output type OT_POSITION, ie the position string for the focused control.
:Description returns a string describing the focused control's selection's position relative to the collection, eg 1 of 10 items etc.
:Returns String of the format 1 of 10 or 0 items.
:Category Dialog Controls

:function PostMessage
:Description Provides limited access to the Windows PostMessage function (See the Windows Platform SDK or a Windows programming book for details) It is only possible to use numeric values for wParam and lParam.  No strings or other structures can be passed.
:Param Handle/hWnd Window to which the message should be posted.
:Param Int/Message Message to be sent.
:Optional
:Param Int/wParam wParam value for the message, defaults to 0.
:Param Int/lParam lParam value for the message, defaults to 0.
:Category Window

:function PriorBrailleString
:Description Displays the prior string of Braille characters that are in the queue of strings that have been received by the Braille device. This function is used when the Braille device is in string mode.
:Returns Int WAS_SUCCESSFUL = 1 (another string was available for display),"WAS_NOT_SUCCESSFUL = 0 (another string was not displayed).
:Category Braille Output

:function PriorCell
:Description When inside a table or spreadsheet, moves the active cursor to the same cell in the prior column.
:Returns Int TRUE if the cursor moved, FALSE otherwise.
:Category Tables

:function PriorCharacter
:Description This performs a special version of the LEFT ARROW or Prior Character keyboard command. When the PC cursor is active, JAWS allows the application to move the cursor. When other cursors are active, JAWS tries to move the cursor to the prior character or graphic it finds to the left of the cursor's current location. To speak the information at the new cursor location, place a SayCharacter function after the PriorCharacter function.
:Category Navigation

:function PriorChunk
:Description This moves the active cursor to the prior chunk. A chunk of text is a section or block of text that is written to the screen at one time, that is, with one function call. This would typically indicate a phrase or description that should be spoken as one unit. This is useful in reading blocks of static text, control prompts, and field names.
:Category Navigation

:function PriorLine
:Description This performs a special version of the UP ARROW keyboard command. When the PC cursor is active, JAWS allows the application to move the cursor. When other cursors are active, then JAWS tries to move the cursor up to the line above its current position. To speak the line of information at the new location, place a SayLine function after the PriorLine function.
:Returns Int
:Category Navigation

:function PriorNonLink
:Synopsis Positions the Virtual cursor at the prior large block of nonlink text.
:Description Often useful for moving back past advertisement text on a Web page.
:Category HTML

:function PriorParagraph
:Description Moves the active cursor to the beginning of the prior paragraph. If the PC cursor is active and the prior paragraph is not already visible, then text in the window will automatically scroll to bring it into view.
:Returns Int TRUE if the prior paragraph was found, FALSE otherwise.
:Category Navigation

:function PriorSentence
:Description Moves the active cursor to the beginning of the prior sentence. If the PC cursor is active and the prior sentence is not already visible, then text in the window will automatically scroll to bring it into view.
:Returns Int TRUE if the prior sentence was found, FALSE otherwise.
:Category Navigation

:function PriorWord
:Description This performs a special version of the CONTROL+LEFT ARROW or Prior Word keyboard command. When the PC cursor is active, JAWS allows the application to move the cursor. When other cursors are active, JAWS tries to move the cursor to the prior word or graphic it finds to the left of the cursor's current location. To speak the word at the new location, place a SayWord function after the PriorWord function.
:Category Navigation

:function ProcessNewText
:Description Used to force a NewTextEvent call. Can be useful if you need to call NewTextEvent before FocusChangedEvent.
:Category Screen Text

:function QuickKeyNavigationModeActive
:Synopsis Determines if the Quick Key Navigation mode is on or off.
:Returns Int TRUE if on, false otherwise
:Category HTML

:function RedirectToUserBuffer
:Synopsis Formats and sends text to the User Buffer and initiates a sayAll.
:Description This function formats and sends text to the User Buffer and initiates a sayAll. %modifiers are processed.
:Returns Void
:Param String/the string to format and send to the User Buffer.
:Category Virtual Viewer

:function Refresh
:Description Refreshes the screen.
:Returns Void
:Optional
:Param Int/forced 1 means force the refresh, 0, only if needed.
:Category Window

:function RefreshWindow
:Description Refreshes the contents of a window and all windows contained within it. This is much faster than refreshing the entire screen.
:Returns Void
:Param Handle Handle of window to be refreshed.
:Category Window

:function ReleaseTestRunner
:Synopsis Releases a TestRunner object that was allocated using GetTestRunner.
:Param Handle/hRunner The handle of the test runner to be released.  This is a handle that was generated in a call to GetTestRunner.
:Category Test

:function ReloadAllConfigs
:Synopsis Reloads all of the current configuration files
:Description This function reloads all the current configuration files. This function is useful for instance when you manually make adjustments too default.jss or default.jcf and recompile using the command line compiler and then wish to see the effects without having to restart JAWS.
:Category Settings

:function ReloadSystemColors
:Synopsis Configure JAWS recognition of colors based on the present palette and system colors.
:Description JAWS monitors for palette change messages and reloads the system colors appropriately when this message is sent.  If, however, an application changes the palette or system colors without broadcasting notification, this function can be used to force JAWS to recognize the modified colors.
:Category Colors

:function RemoveHook
:Description Removes a hook function put in place by AddHook.
:Param Int The type of hook to be installed. Use HK_SCRIPT for this parameter. Hook types are defined in HJConst.JSH.
:Param string The name of a function to be installed as a hook.
:Category Keyboard

:function ResetSynth
:Description Reinitializes the synthesizer with the proper volume, rate, and pitch settings. Used to bring the synthesizer back to normal if it has gotten out of sync with JAWS.
:Category Voices

:function RestoreCursor
:Description Reactivates the cursor that was saved when the SaveCursor function was last used. If the cursor being restored is the JAWS cursor, Invisible cursor, or Braille cursor, then the cursor is also returned to its previous position on the desktop. If the cursor currently in use is different than the cursor that was in use when the SaveCursor function was used, then it is deactivated and the previous cursor is reactivated.
:Category Cursors

:function Return
:Description The Return operator terminates execution of the function in which it appears and returns control (and the value of expression, if given) to the calling function. To define return values, the name of the function is preceded by the return type. Since a script cannot return a value, a Return operator that is used from within a script should never be followed by a value.
:Category Control Flow

:function RGBDecToHex
:Synopsis Converts an RGB decimal string to an RGB hex string, eg "240241242" to "#f0f1f2"
:Description This function converts a Decimal RGB string to a Hex RGB string.
:Returns string The Hex RGB string.
:Param string/sRGBDec the Decimal RGB string.
:Category Colors

:function RGBHexToColor
:Synopsis Converts a hex RGB string to its int equivalent.
:Description This function converts a hex RGB string to its int color value.
:Returns int the color
:Param string/sRGBHex the hex string eg "#rrggbb" or "rrggbb"
:Category Colors

:function RGBHexToDec
:Synopsis Converts an RGB Hex string to an RGB Decimal string, eg "#f0f1f2" or "f0f1f2" to "240241242".
:Description This function converts a Hex RGB string to a Decimal RGB string.
:Returns string the decimal string.
:Param string/sRGBHex the hex string to convert.
:Category Colors

:function RGBStringToColor
:Description Converts a 9-digit string of the form "255255255" to a color value.
:Returns Int A color value suitable for comparison with the values returned by GetColorText or GetColorBackground.
:Param string The 9-digit RGB value to be converted.
:Category Colors

:function RightMouseButton
:Description Used to simulate the clicking of the right button on a mouse. If the function is assigned to a script key and is pressed twice within one second, then this simulates a double click of the mouse button.
:Category Mouse

:function RightMouseButtonLock
:Description This is equivalent to holding down the right mouse button and moving the mouse. It locks the right button down while other tasks are carried out.
:Returns Int "POINTER_ATTACHED" = 1, "POINTER_DETACHED" = 0.
:Category Mouse

:function RouteBrailleToJAWS
:Description Repositions the Braille cursor so that it is in the same position as the JAWS cursor.
:Category Cursors

:function RouteBrailleToPc
:Description Repositions the Braille cursor so that it is in the same position as the PC cursor.
:Category Cursors

:function RouteInvisibleToJAWS
:Description Moves the Invisible cursor to the location of the JAWS cursor and activates the Invisible cursor.
:Category Cursors

:function RouteInvisibleToPc
:Description Moves the Invisible cursor to the location of the PC cursor and activates the Invisible cursor.
:Category Cursors

:function RouteJAWSToBraille
:Description Repositions the JAWS cursor so that it is in the same position as the Braille cursor.
:Category Cursors

:function RouteJAWSToInvisible
:Description Moves the JAWS cursor to the location of the Invisible cursor and activates the JAWS cursor.
:Category Cursors

:function RouteJAWSToPc
:Description This repositions the JAWS cursor so that it is in the same position as the PC cursor. The JAWS cursor is usually connected to the mouse pointer, so when this function is used, it places the mouse pointer on top of the caret or the highlighted selection cursor, or on whatever other type of pointer that is currently being used.
:Category Cursors

:function RoutePCToBraille
:Description Repositions the PC cursor so that it is in the same position as the Braille cursor.
:Category Cursors

:function RoutePcToJAWS
:Description This attempts to move the PC cursor to the position of the JAWS cursor. This function is the same as a single click of the left mouse button, which instructs Windows to move its insertion point to the position of the mouse pointer. The successful use of this function is related to the Windows operating system. There are often situations where Windows cannot move the PC cursor to the mouse pointer.
:Category Cursors

:function RouteVirtualToPc
:Synopsis Moves the Virtual cursor to the position of the PC cursor in an HTML document.
:Description This function moves the Virtual cursor to the position of the PC cursor in an HTML document. For example, when a new page loads and a SayAll is initiated and you want to move back to the formfield with the focus, use this function.
:Category Cursors

:function Run
:Description The Run function is used as if you had entered its name and parameters in the Windows Run dialog. If the file name passed as an argument is the name of a program, then that program is run. If it is the name of a directory, then Windows Explorer is run to explore that directory. If the file is not a program but has an extension associated with a particular application, then that application is run to display the file. For example, passing changes.txt as the parameter to the Run function will open Notepad to edit the file changes.txt.
:Param string  This parameter must be either a text string enclosed in quotes, a variable name that contains a string value, or a script function that returns a string value. In any case, the string needs to be the name of the program you wish to run. It may be necessary to include a path and filename extension. To get the \ into the path name, you must actually use two \ characters. For example, write c:\\jfw32\\jframe.exe. This is very important. Failure to include two \ characters will cause the compiler to fail and jscript.exe to perform an illegal operation.
:Category System

:function RunTestSuite
:Synopsis Run a suite of automated tests.
:Param Handle/hRunner The handle of the test runner to be released.  This is a handle that was generated in a call to GetTestRunner.
:Category Test

:function SaveCursor
:Description Saves the name of the active cursor. If the JAWS cursor, Invisible cursor, or Braille cursor is being used, then the position of the cursor is also saved. Scripts that use the SaveCursor function usually use the RestoreCursor function.
:Category Cursors

:function Say
:Description Speak a string of text using a specific set of speech characteristics called output modes. It is possible to use separate output modes to speak title lines, dialog controls, menu items, etc.  By using the SayMessage function instead, you will be able to assign short and long messages to many output types for JAWS Help and other information.  With Desktop JAWS 5 and later, we suggest that you no longer speak control type and state information with this function.  Instead, use IndicateControlType and IndicateControlState.  Type information includes messages such as "edit" or "button."  State information includes messages such as "checked" or "not checked."
:Param string Type the text that is to be spoken, or specify a variable name or script function that can provide the required text string. Text strings that are typed must be enclosed within quotation marks.
:Param Int Type the constant name that represents the output mode to be used when speaking this text.  See the JFW documentation for specific uses of different output modes.  In many cases, these are specific, and can be disabled from within Configuration Manager, should the user select not to hear a specific type of information.  Examples of output modes are:  OT_HELP, OT_JAWS_MESSAGE or OT_STATUS.
:Optional
:Param Int With Desktop JAWS 5 or later, enter TRUE if your string is marked up with behaviors, e.g. you used any of the SMM functions.
:Category Strings

:function SayActiveCursor
:Description This speaks the name of the active cursor, for example, PC, JAWS, Invisible, or Braille.
:Category Cursors

:function SayAll
:Description This says the active window from the position of the active cursor to the bottom of the window. The cursors move as text is read. If the PC cursor is active the window will scroll to display additional text.
:Category Screen Text

:function SayAllInProgress
:Synopsis determines if sayAll is active.
:Returns Int TRUE or FALSE;
:Category Voices

:function SayCell
:Description When in a table or spreadsheet, speaks the contents of the current cell.
:Returns Int TRUE if in a table, FALSE otherwise
:Category Tables

:function SayCharacter
:Description This says the character or graphic located at the position of the active cursor.
:Category Screen Text

:function SayCharacterByExample
:Description Says a character by example.
:Optional
:Param String character to speak. If not provided, speaks the character at the current cursor.
:Category IME

:function SayCharacterPhonetic
:Description Uses special pronunciation rules to read the character located at the position of the active cursor. For example, A is pronounced alpha, B bravo, etc. The association between characters and their phonetic pronunciations are made in the [PhoneticSpell] section of .JCF files.
:Category Screen Text

:function SayChunk
:Description Says the chunk of information to which the active cursor is pointing. A chunk is text and graphic information that was written to the screen in a single operation. SayChunk is similar to SayField. However, the SayField function uses logic to determine the text that is to be spoken, while SayChunk simply reads the text that was stored in the off screen model as a single unit.
:Returns Void
:Category Screen Text

:function SayColor
:Description Speaks the names of the foreground and background colors of the text at the location of the active cursor.
:Returns Int "TRUE" = 1, Text was found. "FALSE" = 0, cursor was not pointing to text.
:Optional
:Param int/bSpeakRGB if true, speaks the RGB value of the colors, otherwise speaks the name. If an exact match on name isn't found, an approximation is used. This optional parameter is only available in JAWS 5.10 or higher.
:Category Colors

:function SayColumnHeader
:Description When in a table or spreadsheet, speaks the contents of the column header.
:Returns Int TRUE if in a table, FALSE otherwise.
:Category Tables

:function SayControl
:Description Used in dialog boxes to speak the contents of a child window along with its prompt. It reads Edit fields, list boxes, check boxes, radio buttons, etc.
:Param Handle  The information that is spoken by this function is determined by the window handle that is used as a parameter. Type a variable name or choose a script function that can provide a window handle.
:Category Dialog Controls

:function SayControlEx
:Synopsis Handles the speaking of controls for which SayWindowTypeAndText and related functions do not sufficiently describe the control.
:Description This function is designed to be used in the script language to speak a control that requires custom processing (any control for which SayWindowTypeAndText does not properly speak the name and type of the control).  This function is designed to honor the user's output mode settings for each component of the control's description.  This function takes nine parameters, eight of which are string parameters.  The first parameter is the window handle of the control that is to be spoken. The next eight parameters include one parameter for each component of a control's description.  Each string parameter has a corresponding Output Mode.  The eight string parameters are String strControlName = Either OT_DIALOG_NAME, OT_DOCUMENT_NAME, or OT_CONTROL_NAME, depending on the type of window that is to be spoken, String strControlType = OT_CONTROL_TYPE, String strControlState = OT_ITEM_STATE, String strContainerName = OT_CONTROL_GROUP_NAME, String strContainerType = OT_CONTROL_TYPE, String strValue = OT_SELECTED_ITEM, String strPosition = OT_POSITION, String strDialogText = OT_DIALOG_TEXT. This function works by building a string based upon the five components of the control description, adding each component only if the user has specified that this item should speak in the current verbosity level.  Then this function calls Say with the constructed string as the first parameter and OT_NO_DISABLE as the second parameter. If any portion of the control description is not specified, JFW will obtain the default value for that component of the control description and will add the default value of that component to the control description string.  Therefore, if SayWindowTypeAndText speaks every part of a control correctly other than the Control Type, you can call SayControlEx and pass it the Window Handle and the text you would like to be spoken and pass a null string ("") to the function for the remainder of the parameters.  SayControlEx will obtain the default values for the control type, control st. ate, container name, container type, control value, control positional information, and the dialog text if the specified window is the top level window of a dialog box using the same methods as SayWindowTypeAndText and it will include these values in the control description string that is spoken.
:Returns Int Returns 1 if the function sucessfully assembled the control description string and spoke the control description (i.e. the length of the control description string was equal to 0).  If for some reason the function failed to assemble the control description string, the function returns 0.  One reason why this function would return 0 is that the user has specified that all the output modes be turned off in the current verbosity level.
:Param Handle/hwndControl	The window handle of the control.
:Optional
:Param String/strControlName	The name of the control.  This parameter is assigned an Output Mode of either OT_DIALOG_NAME, OT_DOCUMENT_NAME, or OT_CONTROL_NAME, depending on the type of window that is to be spoken.  If the window that is to be spoken has a window type of WT_DIALOG, this parameter is assigned an Output Mode of OT_DIALOG_NAME.  If the specified window is the App Main Window or Real Window, it is assigned an Output Mode of OT_DOCUMENT_NAME.  Otherwise it is assigned an Output Mode of OT_CONTROL_NAME.
:Param String/strControlType	The control type.  This parameter is assigned an Output Mode of OT_CONTROL_TYPE.
:Param String/strControlState	The control state.  This parameter is assigned an Output Mode of OT_ITEM_STATE.
:Param String/strContainerName  The name of the control container box.  For example, if this control is part of a group box, this paramater would be the name of the group box.  This parameter is assigned an Output Mode of OT_CONTROL_GROUP_NAME.
:Param String/strContainerType	The control type of the control container.  This parameter is assigned an Output Mode of OT_CONTROL_TYPE.  It is only spoken if the user has specified that both OT_CONTROL_GROUP_NAME and OT_CONTROL_TYPE are enabled.
:Param String/strValue	The current value of the control.  For example, if the specified control is a list box, the current value of the control is the text of the selected item in the list box.  This parameter is assigned an output mode of OT_SELECTED_ITEM.
:Param String/strPosition	Any relevant positional information for the control. For example if the specified control is a list box, the relevant positional information for the control is the index of the selected item in the list box. This parameter is assigned an output mode of OT_POSITION.
:Param String/strDialogText	If the specified control is the top level window of a dialog box, this parameter specifies the text that is to be spoken as the static text of the dialog box.  This parameter is assigned an output mode of OT_DIALOG_TEXT.
:Category Dialog Controls

:function SayControlExWithMarkup
:Synopsis Handles the speaking of controls for which SayWindowTypeAndText and related functions do not sufficiently describe the control. this function however uses Speech Markup and assumes all parameters are correctly marked up.
:Description This function is designed to be used in the script language to speak a control that requires custom processing (any control for which SayWindowTypeAndText does not properly speak the name and type of the control).  This function is designed to honor the user's output mode settings for each component of the control's description.  This function takes nine parameters, eight of which are string parameters.  The first parameter is the window handle of the control that is to be spoken. The next eight parameters include one parameter for each component of a control's description.  Each string parameter has a corresponding Output Mode.  The eight string parameters are String strControlName = Either OT_DIALOG_NAME, OT_DOCUMENT_NAME, or OT_CONTROL_NAME, depending on the type of window that is to be spoken, String strControlType = OT_CONTROL_TYPE, String strControlState = OT_ITEM_STATE, String strContainerName = OT_CONTROL_GROUP_NAME, String strContainerType = OT_CONTROL_TYPE, String strValue = OT_SELECTED_ITEM, String strPosition = OT_POSITION, String strDialogText = OT_DIALOG_TEXT. This function works by building a string based upon the five components of the control description, adding each component only if the user has specified that this item should speak in the current verbosity level.  Then this function calls Say with the constructed string as the first parameter, OT_NO_DISABLE as the second parameter and specifies that the string contains Speech Markup. If any portion of the control description is not specified, JFW will obtain the default value for that component of the control description and will add the default value of that component to the control description string.  Therefore, if SayWindowTypeAndText speaks every part of a control correctly other than the Control Type, you can call SayControlExWithMarkup and pass it the Window Handle and the text you would like to be spoken and pass a null string ("") to the function for the remainder of the parameters.  SayControlExWithMarkup will obtain the  default values for the control type, control state, container name, container type, control value, control positional information, and the dialog text if the specified window is the top level window of a dialog box using the same methods as SayWindowTypeAndText and it will include these values in the control description string that is spoken. Note that this version of the function assumes that all parameters are using speech markup, ie they contain correct xml markup including symbol replacement (eg < with &lt; etc. This allows a control's type or state or value to be marked up to play sounds, change voice etc.
:Returns Int Returns 1 if the function successfully assembled the control description string and spoke the control description (i.e. the length of the control description string was equal to 0).  If for some reason the function failed to assemble the control description string, the function returns 0.  One reason why this function would return 0 is that the user has specified that all the output modes be turned off in the current verbosity level.
:Param Handle/hwndControl	The window handle of the control.
:Optional
:Param String/strControlName	The name of the control.  This parameter is assigned an Output Mode of either OT_DIALOG_NAME, OT_DOCUMENT_NAME, or OT_CONTROL_NAME, depending on the type of window that is to be spoken.  If the window that is to be spoken has a window type of WT_DIALOG, this parameter is assigned an Output Mode of OT_DIALOG_NAME.  If the specified window is the App Main Window or Real Window, it is assigned an Output Mode of OT_DOCUMENT_NAME.  Otherwise it is assigned an Output Mode of OT_CONTROL_NAME.
:Param String/strControlType	The control type.  This parameter is assigned an Output Mode of OT_CONTROL_TYPE.
:Param String/strControlState	The control state.  This parameter is assigned an Output Mode of OT_ITEM_STATE.
:Param String/strContainerName  The name of the control container box.  For example, if this control is part of a group box, this paramater would be the name of the group box.  This parameter is assigned an Output Mode of OT_CONTROL_GROUP_NAME.
:Param String/strContainerType The control type of the control container.  This parameter is assigned an Output Mode of OT_CONTROL_TYPE.  It is only spoken if the user has specified that both OT_CONTROL_GROUP_NAME and OT_CONTROL_TYPE are enabled.
:Param String/strValue The current value of the control.  For example, if the specified control is a list box, the current value of the control is the text of the selected item in the list box.  This parameter is assigned an output mode of OT_SELECTED_ITEM.
:Param String/strPosition Any relevant positional information for the control. For example if the specified control is a list box, the relevant positional information for the control is the index of the selected item in the list box. This parameter is assigned an output mode of OT_POSITION.
:Param String/strDialogText If the specified control is the top level window of a dialog box, this parameter specifies the text that is to be spoken as the static text of the dialog box.  This parameter is assigned an output mode of OT_DIALOG_TEXT.
:Category Dialog Controls

:function SayControlInformation
:Synopsis Handles the speaking of controls for which SayWindowTypeAndText and related functions do not sufficiently describe the control.
:Description This function is designed to be used in the script language to speak a control that requires custom processing (any control for which SayWindowTypeAndText does not properly speak the name and type of the control).  This function is designed to honor the user's output mode settings for each component of the control's description.  This function takes six parameters, five of which are string parameters.  The first parameter is the window handle of the control that is to be spoken. The next five parameters include one parameter for each component of a control's description.  Each string parameter has a corresponding Output Mode.  The 5 string parameters are String strControlName = Either OT_DIALOG_NAME, OT_DOCUMENT_NAME, or OT_CONTROL_NAME, depending on the type of window that is to be spoken, String strControlType = OT_CONTROL_TYPE, String strControlState = OT_ITEM_STATE, String strContainerName = OT_CONTROL_GROUP_NAME, and String strContainerType = OT_CONTROL_TYPE.  This function works by building a string based upon the five components of the control description, adding each component only if the user has specified that this item should speak in the current verbosity level.  Then this function calls Say with the constructed string as the first parameter and OT_NO_DISABLE as the second parameter.
:Returns Int Returns 1 if the function sucessfully assembled the control description string and spoke the control description (i.e. the length of the control description string was equal to 0).  If for some reason the function failed to assemble the control description string, the function returns 0.  One reason why this function would return 0 is that the user has specified that all the output modes be turned off in the current verbosity level.:Optional
:Optional
:Param String/strControlName	The name of the control.  This parameter is assigned an Output Mode of either OT_DIALOG_NAME, OT_DOCUMENT_NAME, or OT_CONTROL_NAME, depending on the type of window that is to be spoken.  If the window that is to be spoken has a window type of WT_DIALOG, this parameter is assigned an Output Mode of OT_DIALOG_NAME.  If the specified window is the App Main Window or Real Window, it is assigned an Output Mode of OT_DOCUMENT_NAME.  Otherwise it is assigned an Output Mode of OT_CONTROL_NAME.
:Param String/strControlType	The control type.  This parameter is assigned an Output Mode of OT_CONTROL_TYPE.
:Param String/strControlState	The control state.  This parameter is assigned an Output Mode of OT_ITEM_STATE
:Param String/strContainerName  The name of the control container box.  For example, if this control is part of a group box, this paramater would be the name of the group box.  This parameter is assigned an Output Mode of OT_CONTROL_GROUP_NAME.
:Param String/strContainerType	The control type of the control container.  This parameter is assigned an Output Mode of OT_CONTROL_TYPE.  It is only spoken if the user has specified that both OT_CONTROL_GROUP_NAME and OT_CONTROL_TYPE are enabled.
:Category Dialog Controls

:function SayCurrentScriptKeyLabel
:Synopsis Speaks the key name attached to the script.
:Description Speaks the Key Name attached to the current script, honoring both the typing echo setting and the label as defined in DEFAULT.JCF.
:Category Scripts

:function SayCursorPos
:Description This speaks the row and column position of a cursor. The row and column spoken is based upon the number of pixels of the active cursor position from the top left corner of the screen.
:Param Int Type the constant value that represents a cursor, type a variable name, or choose a script function. Cursor constants are: CURSOR_JAWS, CURSOR_PC, CURSOR_INVISIBLE, CURSOR_Braille. A script function such as GetActiveCursor also can provide the constant.
:Category Cursors

:function SayField
:Description This says the field of text where the active cursor is pointing. A field of text is a section or block of text that has a common attribute such as bold, underlined, italics, or strikeout. The use of the attribute must be contiguous. The SayField function uses logic to determine the text that is to be spoken, while the SayChunk function simply says what JAWS considers to be a single block of text.
:Category Screen Text

:function SayFocusRect
:Description Says the contents of focus rectangle. Returns TRUE if any text was spoken, FALSE otherwise.
:Returns Int  "True" or "False", 1 or 0.
:Param Handle Handle of window.
:Category Window

:function SayFocusRects
:Description Says the contents of focus rectangles. If there is only one such rectangle, this acts like SayFocusRect, which says only the first one. If there is more than one, says the contents of all of them.
:Returns Int TRUE if text was spoken, FALSE otherwise.
:Param Handle Handle of window.
:Category Window

:function SayFont
:Description Identifies the font name, font size, and font attributes (For example: bold, underline, italic) that are associated with the character at the active cursor. The information that is reported is for the font that appears on the desktop, and usually does not correspond to the size of the font that will be printed on a printer. Refer to "FONTSIZE.TXT" in the \JFWxx\TECNOTES subdirectory for tips on working with fonts.
:Category Text Format

:function SayFormattedMessage
:Synopsis Formats the messages which are passed, and speaks a message based on the specified output type.
:Description This function takes short and long messages and speaks the appropriate message based on the given output type. The messages which are passed may have formatting strings such as %KeyFor() in them, as they will be formatted by the function.  If using the output mode OT_USER_BUFFER, to place text in the User Buffer, do not include the short message as it will be ignored.  With Desktop JAWS 5 and later, we suggest that you no longer speak control type and state information with this function.  Instead, use IndicateControlType and IndicateControlState.  Type information includes messages such as "edit" or "button."  State information includes messages such as "checked" or "not checked."
:Param Int/iOutputType The constant representing the desired output type for the given set of messages. A list of available output type constants can be found in hjconst.jsh.
:Param String/sLong A quoted string of text, a message constant, or a string variable containing the desired long message. If you require only one message, enter it for this parameter and leave the third parameter blank
:Optional
:Param String/sShort A quoted string of text, a message constant, or a string variable containing the desired short message. If you would like the short message to speak nothing, enter the constant msgSilent for this parameter.  If using the output type OT_USER_BUFFER, enter nothing at all.
:Category Strings

:function SayFrame
:Description Speaks the contents of a specific frame.
:Returns Int TRUE if the desired frame exists, FALSE otherwise.
:Param string The name of the frame to speak.
:Category Frames

:function SayFrameAtCursor
:Description Speaks the contents of the frame that surrounds the location of the current cursor.
:Returns Int TRUE if a frame surrounds the current cursor, FALSE otherwise.
:Category Frames

:function SayFromCursor
:Description Reads text on the current line that is located to the right of the current cursor. It will read the character that is being pointed to by the insertion point or active cursor.
:Category Screen Text

:function SayInteger
:Description This speaks a string of numeric data.
:Param Int Type a variable name or choose a script function that will provide numeric data.
:Category Strings

:function SayLine
:Description This says a line of text where the active cursor is located. JAWS must interpret whether text that has a similar vertical position is on the same line. When the PC cursor is active, it only reads the information that is within the active child window. When it is used with other cursors, then it reads from one edge of the application window to the other.
:Category Screen Text

:function SayMessage
:Synopsis Speaks the given message based on the specified output type.
:Description This function takes short and long messages and speaks the appropriate message based on the given output type.  If using the output type of OT_USER_BUFFER, which is designed to present text in the User buffer, do not use the short message as it will be ignored.  With Desktop JAWS 5 and later, we suggest that you no longer speak control type and state information with this function.  Instead, use IndicateControlType and IndicateControlState.  Type information includes messages such as "edit" or "button."  State information includes messages such as "checked" or "not checked"
:Param Int/iOutputType The constant representing the desired output type for the given set of messages. A list of available output type constants can be found in hjconst.jsh.
:Param String/sLong A quoted string of text, a message constant, or a string variable containing the desired long message. If you require only one message, enter it for this parameter and leave the third parameter blank
:Optional
:Param String/sShort A quoted string of text, a message constant, or a string variable containing the desired short message. If you would like the short message to speak nothing, enter the constant cmsgSilent for this parameter.  For the user buffer (OT_USER_BUFFER), enter nothing at all.
:Category Strings

:function SayObjectActiveItem
:Description Says the active element in certain controls. For example in a list view, it will say the selected item. In a menu, it will say the active menu item. In a dialog box, it will say the selected tab.
:Returns Void
:Category Object Model And MSAA

:function SayObjectTypeAndText
:Description Speaks the name and type of the object located at the current cursor's location. This function is similar to SayWindowTypeAndText, except that it is more specific. If a particular window contains multiple objects, this function will speak information about the one at the cursor, while SayWindowTypeAndText will speak information about the enclosing window. If the window does not contain multiple objects, then the functions operate identically. When this function is used, it marks the text it reads so that the Say Highlighted Text and Say NonHighlighted Text functions do not repeat the same information when they are triggered.
:Category Object Model And MSAA

:function SayParagraph
:Description Reads the paragraph containing the character on which the active cursor is positioned.
:Returns Int TRUE if a paragraph was found at the current cursor location, FALSE otherwise.
:Category Screen Text

:function SayPhraseByExample
:Description Says a phrase by example.
:Optional
:Param String phrase to speak. If not provided, speaks the phrase at the current cursor.
:Category IME

:function SayRowHeader
:Description When in a table or spreadsheet, speaks the contents of the row header.
:Returns Int TRUE if in a table, FALSE otherwise.
:Category Tables

:function SaySentence
:Description Reads the sentence containing the character on which the active cursor is positioned.
:Returns Int TRUE if a sentence was found at the current cursor location, FALSE otherwise.
:Category Screen Text

:function SayString
:Description The SayString makes the speech synthesizer speak a message. This function is now obsolete since the implementation of the sayMessage function. This function remains for the purpose of testing and debugging. If you are developing new scripts, it is recommended that you do not use this function. Instead, use the SayMessage function.
:Param string  This parameter must be either a text string enclosed in quotes, a variable name that contains a string value, or a  function that returns a string value.
:Category Strings

:function SayTextBetween
:Description Says the text between two points on the screen.
:Returns Int TRUE if text spoken, FALSE otherwise.
:Param Int Screen coordinate of left edge of area to speak.
:Param Int Screen coordinate of right edge of area to speak.
:Category Screen Text

:function SayToBottom
:Description Says the active window from the position of the active cursor to the bottom of the window. The cursors do not move as text is read, the window will not scroll to display additional text.
:Returns Void
:Category Window

:function SayToCursor
:Description Reads text on the current line that is located to the left of the active cursor. It does not read the character that is being pointed to by the insertion point or active cursor.
:Category Screen Text

:function SayToPunctuation
:Description Speaks  text between the current cursor and the end of the line or the next punctuation symbol, which ever comes first.
:Category Screen Text

:function SayUsingVoice
:Description Speak a string of text using a specific synthisizer voice.
:Param String Type in the constant representing the voice to be used. These constants are defined in the file hjconst.jsh and are listed below: VCTX_GLOBAL, VCTX_MESSAGE, VCTX_KEYBOARD, VCTX_SCREEN, VCTX_PCCURSOR, VCTX_JAWSCURSOR
:Param String Type the text that is to be spoken, or specify a variable name or script function that can provide the required text string. Text strings that are typed must be enclosed within quotation marks.
:Param Int Type in one of the following constants that represent the output mode to be used: OT_STRING, OT_LINE, OT_WORD, OT_CHAR, OT_FIELD, OT_CHUNK, OT_SAYALL, OT_SPELL, OT_PHONEMIC, OT_APP_NAME, OT_DIALOG_NAME, OT_CONTROL_NAME, OT_MDI_NAME, OT_WINDOW_NAME, OT_GRAPHIC, OT_HELP, OT_STATUS, OT_SELECTED, OT_TEXT, OT_POSITION, OT_STATIC, OT_FONT, OT_KEYBOARD, OT_CURSOR, OT_DEBUG.
:Optional
:Param Int Not available yet
:Category Voices

:function SayWindow
:Description Reads the specified window. It reads either highlighted text or all text in the window.
:Param Handle Type the name of a variable or choose a script function that provides the handle of the window that is to be spoken.
:Param Int Type a constant to determine how much information is to be read: READ_EVERYTHING" = 0, "READ_HIGHLIGHTED" = 1.
:Category Window

:function SayWindowTypeAndText
:Description Reads a specified series of information from a window. It reads the window title (when one is present), the window type, the contents in the window, and provides related information about the current dialog option. This function marks the text it reads so that the Say NonHighlighted text and Say Highlighted text functions do not repeat the same information when they are triggered.
:Param Handle Type the name of a variable or choose a script function that provides the handle of the window that is to be read.
:Category Window

:function SayWord
:Description This says the word or graphic located at the position of the active cursor.
:Category Screen Text

:function ScheduleFunction
:Description Runs a user defined function in a set period of time. Useful when you want to perform a task and then check on the results at a later time. Once this function is used, you can call UnScheduleFunction to cause the user-defined event not to run.
:Returns Int An ID that can be used to call UnScheduleFunction. If 0 is returned, then the timer was not successfully set.
:Param String/FunctionName Name of function to be executed.
:Param Int/Time Amount of time to elapse before the function is executed. Time is measured in tenths of a second. A value of 10 is one second.
:Category Scripts

:function ScreenEcho
:Description Cycles through the various settings for screen echo. The screen echo setting determines the amount of information that is to be read as the information is displayed on the desktop. The Say NonHighlighted text and Say Highlighted text functions often check the setting for screen echo before deciding how much information to speak.
:Category Screen Text

:function ScreenGetHeight
:Description Gets the height of the screen in pixels.
:Returns Int The height of the screen in pixels.
:Category System

:function ScreenGetWidth
:Description Gets the width of the screen in pixels.
:Returns Int The width of the screen in pixels.
:Category System

:function ScreenStabilizedEvent
:Synopsis Called when the screen has become stable.
:Description This event is triggered after no screen writes have occured within a reasonable amount of time. The window handle of the last window to which text was written is passed as the parameter to this event.
:Returns Void
:Param Handle/hwndLastTextWrite the window handle where the last text write occured.
:Category Screen Text

:function SDMGetCurrentControl
:Description Retrieves the ID of the control on which the active cursor is positioned inside an SDM dialog box.
:Returns Int The ID of the SDM control in which the active cursor is positioned, or 0 if not inside an SDM dialog box.
:Category Dialog Controls

:function SDMGetFirstControl
:Description Obtains the control ID of the first dialog option in an SDM dialog box. It can provide the control ID that is needed by the SDMSayControl function.
:Returns Int Provides control ID.
:Param Handle Type a variable name or choose a script function that can provide the window handle for the SDM dialog box. The GetFocus function is often used to provide the handle.
:Category Dialog Controls

:function SDMGetFocus
:Description Used to get the control ID of the active dialog option or control in an SDM dialog box. This function is most often used as a parameter for the SDMSayWindowTypeAndText function to provide it with a control ID.
:Returns Int Provides The control ID within an SDM dialog.
:Param Handle Use the GetFocus function to obtain the handle of the current SDM window.
:Category Dialog Controls

:function SDMGetLastControl
:Description Provides the control ID for the last option in an SDM dialog box. It can provide the control ID that is needed by the SDMSayControl function.
:Returns Int Provides control ID.
:Param Handle Type a variable name or choose a script function that can provide the window handle of the SDM dialog. The GetFocus function is often used to provide the handle.
:Category Dialog Controls

:function SDMGetNextControl
:Description Obtains the control ID for the next option in an SDM dialog box. It can provide the control ID that is needed by the SDMSayControl function.
:Returns Int A control ID is returned when the next control ID is found, 0 is returned when a control ID does not exist.
:Param Handle Type a variable name or choose a script function that can provide the window handle of the SDM dialog box. The GetFocus function is often used to provide the handle.
:Param Int Type a variable name or choose a script function that indicates the control ID for the child window which is the starting point for the script function in the SDM dialog.
:Category Dialog Controls

:function SDMGetPrevControl
:Description Provides the control ID for the previous option in an SDM dialog box. It can provide the control ID that is needed by the SDMSayControl function.
:Returns Int A control ID is returned when the previous control ID is found, 0 is returned when a control ID does not exist.
:Param Handle Type a variable name or choose a script function that can provide the window handle of the SDM dialog box. The GetFocus function is often used to provide the handle.
:Param Int Type a variable name or choose a script function that indicates the control ID for the child window which is the starting point for the script function in the SDM dialog.
:Category Dialog Controls

:function SDMSayControl
:Description Speaks the contents of a child window along with its prompt in an SDM dialog box. It reads edit fields, list boxes, check boxes, radio buttons, etc. This function is equivalent to SayControl, but is exclusively designed for SDM dialog boxes. All child windows in an SDM dialog box have the same window handle, and the control ID is used to distinguish between the various options in the dialog box.
:Param Handle Type a variable name or choose a script function that can provide the window handle for the dialog box. The GetFocus function is often used to provide the handle.
:Param Int Type a variable name or choose a script function that can provide the control ID for the child window which is to be spoken. Various SDM control ID functions can be used to identify the child window.
:Category Dialog Controls

:function SDMSayStaticText
:Description Reads a type of text called static text that may be displayed in an SDM dialog box. It does not read the text in edit fields, check boxes, and so on, or the titles or prompts that are often associated with dialog options
:Param Handle Use the GetFocus function to obtain the handle of the current SDM window.
:Category Dialog Controls

:function SDMSayWindowTypeAndText
:Description Used with SDM windows to read the window title (when one is present), the window type, the contents in the window, and related information about the current dialog box option. When this function is used, it marks the text it reads so that the SayNonHighlightedText and SayHighlightedText functions do not repeat the same information when they are triggered. This function is only used with SDM windows and not with regular dialog windows.
:Param Handle Type the name of a variable or choose a script function that provides the handle of the window that is to be read. The GetFocus function is often used to provide the handle of the SDM window.
:Param Int Use the SDMGetFocus function to provide the control ID for the active child window of the dialog box.
:Category Dialog Controls

:function SelectFromStartOfLine
:Description When the PC cursor is active, JAWS allows the application to select from the start of the current line to the PC cursor. When a portion of text is selected, JAWS automatically speaks the newly highlighted text if screen echo is set to Highlighted or All
:Category Selection

:function SelectFromTop
:Description When the PC cursor is active, JAWS allows the application to select from the top of the document to the PC cursor. When a portion of text is selected, JAWS automatically speaks the newly highlighted text if screen echo is set to Highlighted or All.
:Category Selection

:function SelectHierarchicalElement
:Synopsis Selects an HTML element's contents
:Description this function selects the text contained in an HTML element. For example, if you are on the table introduction (table with x columns and y rows) and you call this function then the entire table will be selected. If however you are in a table cell then just the table cell will be selected.
:Category HTML

:function SelectNextCharacter
:Description When the PC cursor is active, JAWS allows the application to select the next character. When a character is selected, JAWS automatically speaks the character if screen echo is set to Highlighted or All.
:Category Selection

:function SelectNextLine
:Description When the PC cursor is active, JAWS allows the application to select the next line. When a line is selected, JAWS automatically speaks the line if screen echo is set to Highlighted or All.
:Category Selection

:function SelectNextScreen
:Description When the PC cursor is active, JAWS allows the application to select the next page beginning at the PC cursor. When a portion of text is selected, JAWS automatically speaks the newly highlighted text if screen echo is set to Highlighted or All.
:Category Selection

:function SelectNextWord
:Description When the PC cursor is active, JAWS allows the application to select the next word. When a word is selected, JAWS automatically speaks the word if screen echo is set to Highlighted or All.
:Category Selection

:function SelectPriorCharacter
:Description When the PC cursor is active, JAWS allows the application to select the prior character. When a character is selected, JAWS automatically speaks the character if screen echo is set to Highlighted or All.
:Category Selection

:function SelectPriorLine
:Description When the PC cursor is active, JAWS allows the application to select the prior line. When a line is selected, JAWS automatically speaks the line if screen echo is set to Highlighted or All.
:Category Selection

:function SelectPriorScreen
:Description When the PC cursor is active, JAWS allows the application to select the prior page ending at the PC cursor. When a portion of text is selected, JAWS automatically speaks the newly highlighted text if screen echo is set to Highlighted or All.
:Category Selection

:function SelectPriorWord
:Description When the PC cursor is active, JAWS allows the application to select the prior word. When a word is selected, JAWS automatically speaks the word if screen echo is set to Highlighted or All.
:Category Selection

:function SelectToBottom
:Description When the PC cursor is active, JAWS allows the application to select from the PC cursor to the end of the document. When a portion of text is selected, JAWS automatically speaks the newly highlighted text if screen echo is set to Highlighted or All.
:Category Selection

:function SelectToEndOfLine
:Description When the PC cursor is active, JAWS allows the application to select to the end of the current line starting at the PC cursor. When a portion of text is selected, JAWS automatically speaks the newly highlighted text if screen echo is set to Highlighted or All.
:Category Selection

:function SendMessage
:Description Provides limited access to the Windows SendMessage function (See the Windows Platform SDK or a Windows programming book for details) It is only possible to use numeric values for wParam and lParam.  No strings or other structures can be passed.  The return value is always treated as an integer.
:Returns Int result of the SendMessage call.
:Param Handle/hWnd Window to which the message should be sent.
:Param Int/Message Message to be sent.
:Optional
:Param Int/wParam wParam value for the message, defaults to 0.
:Param Int/lParam lParam value for the message, defaults to 0.
:Category Window

:function SetBrailleMessageStatusText
:Synopsis Enables the user to define the text to be shown either in the status area of the Braille display or prepended to a Flash message during the display of a Flash message.
:Description This function enables the user to define the text to be shown either in the status area of the Braille display or prepended to a Flash message during the display of a Flash message. If the string parameter is not supplied or is NULL, the default status message as defined in the jcf file will be restored and used.
:Returns int TRUE if the function succeeds, false otherwise.
:Optional
:Param string sStatusMsg the text to be shown in the status cell area of the display or prepended to a Flash message if the display has no status cells.
:Category Braille Output

:function SetBrailleRestriction
:Synopsis Specifies the area within which the Braille cursor is free to move.
:Description selects the area within which the Braille cursor is fre to move. Note has no effect if Tether Braille To Active is on.
:Returns Int TRUE if the resttriction was set, false if the Braille cursor is tethered to another cursor.
:Param Int one of  the constants beginning with Restrict defined in hjconst.jsh.   Use RestrictNone to allow the cursor to roam the screen, RestrictAppWindowto restrict to the application window, RestrictRealWindow to restrict to the real window or RestrictWindow to restrict to the current window.
:Category Cursors

:function SetCurrentItem
:Description Moves focus to a specified item in a ListView or combobox.  Note that this does not bring the ListView or combobox window into focus, it simply causes a specific item to be the focused item in that window.  This function expands the functionality of lvSetFocusItem to also work for comboboxes.
:Returns Int TRUE if successful, FALSE otherwise.
:Param Handle The window containing a ListView or combobox.
:Param Int The 1-based index of the row in the ListView or combobox to receive focus.
:Category Dialog Controls

:function SetDefaultJCFOption
:Description Changes the default value for an option in the default JAWS configuration file. Settings in DEFAULT.JCF are used until a JCF is loaded for an application. When a JCF is not available for the application, then settings in the default JCF continue to be used. The function SetJcfOption is used to set a value in the JCF for an active application.
:Returns Int "WAS_SUCCESSFUL" = 1 (the value was changed), "WAS_NOT_SUCCESSFUL" = 0 (it was not changed).
:Param Int Type the constant value that names the option you wish to change. Constant values are listed in HJCONST.JSH, and begin with the prefix "OPT_" or "OPTBRL_." Constants beginning with "OPTBRL_" are for Braille devices.
:Param Int Type the number to be used as the setting for the option.
:Category Settings

:function SetFocus
:Description Moves the focus to a specified window.
:Param Handle Handle of window to which focus should be moved.
:Category Window

:function SetGraphicLabel
:Description Adds a graphic label to the specified graphics file (jgf).
:Returns Int TRUE if the label is successfully added.
:Param Int/nGraphicID The ID of the graphic. GetGraphicID returns this value.
:Param String/nLabel The label to be assigned to the graphic.
:Param Int/bApp If bApp is TRUE, then the graphic label is added to the application-specific graphic file. If FALSE, then it is added to the default graphic file.
:Category Graphics

:function SetJAWSFindText
:Description Sets the text to be located when JAWSFindNext runs.
:Category Screen Text

:function SetJAWSLanguage
:Description In the international versions of JFW, changes the JAWS operating environment to the specified language.
:Returns Int  TRUE if change was successful, FALSE otherwise.
:Param string A 3-character Windows language abbreviation (ENU for English, DEU for German, and so on.)
:Category Settings

:function SetJCFOption
:Description Changes a value in the JAWS configuration file for the active application. A new JCF file is loaded each time a different application is used. When a JCF is not available for the application, then the settings in the DEFAULT.JCF are used. The SetDefaultOption is used to change a default JCF option.
:Returns Int "WAS_SUCCESSFUL" = 1 (the value was changed), "WAS_NOT_SUCCESSFUL" = 0 (it was not changed).
:Param Int Type the constant value that names the option you wish to change. Constant values are listed in HJCONST.JSH, and begin with the prefix "OPT_" or "OPTBRL_." Constants beginning with "OPTBRL_" are for Braille devices.
:Param Int Type the number to be used as the setting for the option.
:Category Settings

:function SetLastScriptKey
:Description Sets the name of the last key used for a script. Useful when it is necessary to assign a specific key name to be retrieved by GetCurrentScriptKeyName.
:Returns int True if the set was successful, false otherwise.
:Param string The key name to use.
:Category Script

:function SetQuickKeyNavigationMode
:Synopsis allows scripter to manually turn on or off the Quick Key Navigation mode..
:Description The Quick Key Navigation mode is linked to the Virtual Cursor automatically however it may be manually turned on in other applications which don't use the Virtual cursor. Applications which use this mode must have overriding scripts to handle the movement and reading functions supported by this mode. this mode is linked to the JCF option OPT_QUICK_KEY_NAVIGATION_MODE so turning it on manually when the jcf option is set to 0 will have no effect.
:Returns Int true if the mode was enabled or false otherwise.
:Param Int true to turn the mode on, false to turn it off.
:Category HTML

:function SetRegistryEntryDWORD
:Synopsis Sets a DWORD entry into the registry, first parameter represents root key.
:Description Use to set DWORD entries in registry.
:Returns int 1 if successful, otherwise 0.
:Param int 0=HKEY_CLASSES_ROOT, 1=HKEY_CURRENT_USER, 2=HKEY_LOCAL_MACHINE, 3=HKEY_USERS.
:Param String/byRef/Name of SubKey.
:Param String/byRef/Name of Variable
:Param int/DWORD to be Assigned variable.
:Category System

:function SetRegistryEntryString
:Synopsis Sets a string entry into the registry, first parameter represents root key.
:Description Use to set string entries in registry.
:Returns int 1 if successful, otherwise 0.
:Param int 0=HKEY_CLASSES_ROOT, 1=HKEY_CURRENT_USER, 2=HKEY_LOCAL_MACHINE, 3=HKEY_USERS.
:Param String/byRef/Name of SubKey.
:Param String/byRef/Name of Variable.
:Param String/byRef/String to be Assigned variable.
:Category System

:function SetRestriction
:Synopsis Specifies the area within which the current cursor is free to move.
:Description For all cursors except the PC cursor, selects the area within which the cursor is fre to move.
:Returns Int FALSE when the PC cursor is on, TRUE otherwise.
:Param Int one of  the constants beginning with Restrict defined in hjconst.jsh.   Use RestrictNone to allow the cursor to roam the screen, RestrictAppWindowto restrict to the application window, RestrictRealWindow to restrict to the real window or RestrictWindow to restrict to the current window.
:Category Cursors

:function SetRestrictionToFrame
:Synopsis Restricst the active cursor to within a specific frame.
:Description For all cursors except the PC cursor, selects the area within which the cursor is fre to move.
:Returns Int FALSE if the PC cursor is on or if the specified frame does not exist, TRUE otherwise.
:Param String/strFrame The name of the frame whose borders will serve as restricting boundaries for the cursor.
:Category Cursors

:function SetRestrictionToRect
:Synopsis Restricst the active cursor to within a specific rectangle.
:Description For all cursors except the PC cursor, selects the area within which the cursor is fre to move.
:Returns Int FALSE if the PC cursor is on or if the  rectangle is invalid, TRUE otherwise.
:Param Int/Left Left edge of rectangle.
:Param Int/Top top edge of rectangle.
:Param Int/Right right edge of rectangle.
:Param Int/Bottom bottom edge of rectangle.
:Category Cursors

:function SetSynth
:Description Causes JFW to switch to the specified synthesizer.
:Returns Int TRUE if change was successful, FALSE otherwise.
:Param String/strShortName The short name of the synthesizer found in JFW.INI. This name must be in quotes. For example, you can find the short name for Eloquence by looking in JFW.INI for the entry "Synth1Name=eloq." You would then use the line SetSynth("eloq") in your script or function.
:Category Voices

:function SetSynthLanguage
:Description For synthesizers that support multiple languages, changes the synthesizer to the specified language.
:Returns Int TRUE if change was successful, FALSE otherwise.
:Param String Enter the language to be switched to, exactly as it appears in the Synthesizer Language submenu of the Language menu. Example; SetSynthLanguage ("American English")
:Category Voices

:function SetSystemVolume
:Description Sets the system volume.
:Returns Void
:Param Int/NewValue The new value to which you wish to set the volume.
:Category System

:function SetTypingEchoLanguage
:Synopsis Sets the synth language which should be used for typing echo.
:Description This function allows the user to change the language JAWS uses for typing echo. If a valid language abbreviation is supplied, that language will be used (if supported by the Synthesiser in use) otherwise the global language will be used.  Note this is only available in JAWS 5.0 International (v 5.00.709 or higher).
:Returns int True if we were able to switch the typing echo language, FALSE otherwise.
:Optional
:Param string/sLanguageCode any language code for which a language alias is defined for the current synth or a language string understood by the current synth. Note this function only supports aliases which map to an actual language switch (rather than a voice switch).
:Category Keyboard

:function SetVoiceParameters
:Description sets the parameters for the voice context you specify.  These include Volume, Rate, Pitch, Punctuation and person.
:Returns Void
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Param Int/volume/ Type the variable to setthe voice volume setting.
:Param Int/Rate Type the variable to set the voice rate setting.
:Param Int/Pitch Type the variable to set the voice pitch setting.
:Param Int/Punctuation Type the variable to set the voice punctuation setting.
:Param String/Person Type the variable to set the voice person setting.
:Category Voices

:function SetVoicePerson
:Description Sets the person of the voice you specify to the amount passed to the second parameter.
:Returns Void
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Param String/NewPerson The new person to which you wish to set the voice context.
:Category Voices

:function SetVoicePitch
:Description Sets the pitch of the voice you specify to the amount passed to the second parameter.
:Returns Void
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Param Int/NewValue The new value to which you wish to set the pitch.
:Category Voices

:function SetVoicePunctuation
:Description Sets the punctuation of the voice you specify to the amount passed to the second parameter.
:Returns Void
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Param Int/NewValue The new value to which you wish to set the punctuation.
:Category Voices

:function SetVoiceRate
:Description Sets the rate of the voice you specify to the amount passed to the second parameter.
:Returns Void
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Param Int/NewValue The new value to which you wish to set the rate.
:Category Voices

:function SetVoiceVolume
:Description Sets the volume of the voice you specify to the amount passed to the second parameter.
:Returns Void
:Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.
:Param Int/NewValue The new value to which you wish to set the volume.
:Category Voices

:function ShiftEnterKey
:Synopsis The SHIFT+ENTER key is passed to the application.
:Description Passes the SHIFT+ENTER key through to the application. If the Virtual PC cursor is active and on a link then the link is opened in a new browser window.
:Returns Void
:Category Keyboard

:function ShiftLeftMouseClick
:Description Sends a SHIFT+LEFT Mouse Click to the system, useful for selecting contiguous text or items in a list with the mouse pointer.
:Category Mouse

:function ShiftTabKey
:Synopsis Passes the SHIFT+TAB keystroke through to the application.
:Description The SHIFT+TAB keystroke is passed to the application. If the Virtual PC cursor is active, it is moved to the previous link or control in the tab order.
:Category Keyboard

:function ShouldItemBraille
:Synopsis Determines if a string with a given Output Mode should be Brailled.
:Description This function is used to determine whether or not the user has specified that items spoken with a given Output Mode should also be Brailled in the current Braille verbosity level.
:Returns Int Returns 0 if the item should not be Brailled.  Returns a non 0 value if the item should be Brailled.
:Param Int/iOutputMode The Output Mode of the item you wish to determine if it should be Brailled.
:Category Settings

:function ShouldItemSpeak
:Synopsis Determines if a string with a given Output Mode should be spoken.
:Description This function is used to determine whether or not the user has specified that items spoken with a given Output Mode should be spoken in the current verbosity level.
:Returns Int Returns 0 if the item should not be spoken.  Returns a non 0 value if the item should be spoken.
:Param Int/iOutputMode The Output Mode of the item you wish to determine if it should be spoken.
:Category Settings

:function ShowHelpByID
:Description Opens up WinHelp using a specified file and topic ID.
:Returns Int TRUE if the help file was successfully displayed.
:Param String/strHelpFile The name of a help file. If a complete path is given, then it is used. If only a file name is given, then the default JFW help path is build around it and used.
:Param Int/nID The ID of the help topic.
:Category Help

:function ShowHelpByName
:Description Opens up WinHelp using a specified file and index topic.
:Returns Int TRUE if the Help file was successfully displayed.
:Param String/strHelpFile The name of a help file. If a complete path is given, then it is used. If only a file name is given, then the default JFW help path is build around it and used.
:Param String/strKey The index string of the Help topic.
:Category Help

:function ShutDownJAWS
:Description Closes or quits the JAWS application. The JAWS user is automatically prompted to confirm the intention to terminate JAWS before speech stops.
:Category JAWS Program

:function ShutDownMAGic
:Synopsis Shuts down the MAGic program.
:Description Finds the MAGic window and sends a WM_CLOSE to it.
:Returns Int FALSE if the MAGic window could not be shut down. Otherwise TRUE.
:Category MAGic

:function SimulateKey
:Synopsis simulates performing the key.
:Description If the key name is attached to a script, performs the script; otherwise, sends the key to the application.
:Returns int if the key simulation was successful, false otherwise.
:Param string the key name to be performed.
:Category Keyboard

:function SkimRead
:Synopsis Starts skimreading from the cursor.
:Description Skimreading allows the user to read out certain portions of a document while skipping over irrelevant information. The Skimreading mode maybe specified along with an optional text expression which determines which information is read.
:Optional
:Param int/iMode Modes are defined in HJConst.jsh and include srmOff (equivalent to a SayAll), srmFirstLineOfParagraph (just read the first line of each paragraph), srmFirstSentenceOfParagraph (just the first sentence of each paragraph) or srmTextMatchingRegularExpression (read just the units of text which match the supplied Regular Expression.
:Param int/bIndicateSkimming TRUE to indicate JAWS is skimming, a beep will be heard every 20 units skimmed. The unit will depend on the current SayAll mode.
:Param string/sRegularExpression Is a regular expression defining what text should be present or absent in the text unit in order for it to be spoken. Some examples include Joe|Blogs|Fred (read units including the names Joe, Blogs or Fred), Joe&~BLogs (text units containing Joe but not Blogs), etc. See the documentation for the full regular expression syntax as it is very powerful.
:Param int/nTextRuleUnit when srmTextMatchingRegularExpression is used, the text unit to which the rule is applied and the unit spoken on a match.
:Param int/bSilentSkimSummarizeAtEnd if true, does not read each match but adds the text to the User Buffer and presents all matches at once when the SkimRead is stopped or completes (JAWS 6.10 and higher) defaults to FALSE.
:Category Screen Text

:function SkimReadShouldSpeakText
:Synopsis Used to determine if the current unit should be spoken when skimreading is being controlled by scripts (eg in MSWord).
:Description This function is only used when skimreading is being controlled externally by scripts as in MSWord.
:Returns int true or false
:Param string/sText text of unit to be checked against the current skimreading parameters. If skimreading is set to srmTextMatchesRegularExpression then the regular expression will be applied to this text and the function will return true if it should be spoken, false otherwise. If the skimreading mode is set to anything other than srmTextMatchesRegularExpression, the function will return TRUE unless a skimread is not in progress.
:Category Scripts

:function smmGetBehavior
:Synopsis Obtains the current behavior for a given scheme property.
:Description This function allows the scripter to obtain a scheme behavior.
:Returns int the behavior for the given table and key.
:Param string/sBehaviorTableName the category of behaviors you wish too query. this is taken from the section name in the SMF file (minus the "Behavior table" suffix), for example, if you wish to query an Attribute behavior, the value of this parameter should be set to "Attribute".
:Param string/sKey the key from the behavior table you wish to query.
:Param string/byRef/sData the data for the behavior. this piece of data will correspond to data1 through data4 for that given table and key, see the smf files for more detail. for example, if the behavior is speak item then the data will contain the optional text and voice alias used to speak the item. If the behavior is to change language then the data will contain the language alias etc.
:Category Speech Markup

:function smmGetBehaviorForControlState
:Synopsis Gets the behavior which will be used for the specified control state.
:Description See hjconst.jsh for the list of valid behavior constants.
:Returns Int a constant representing the behavior.
:Param Int/iControlstate the control state whose behavior you want.
:Category Speech Markup

:function smmGetBehaviorForControlType
:Synopsis Gets the behavior which will be used for the specified control type.
:Description See hjconst.jsh for the list of valid behavior constants.
:Returns Int a constant representing the behavior.
:Param Int/iControltype the control type whose behavior you want.
:Category Speech Markup

:function smmGetEndMarkupForAllCaps
:Synopsis Returns the end Speech Markup mapping for a capitalized word.
:Description This function returns the end markup which will be used for a capitalized word.
:Returns String the end Speech Markup which will be used to indicate a capitalized word. Note that some behaviors don't require an end tag and hence this will be blank.
:Category Speech Markup

:function smmGetEndMarkupForAttributes
:Synopsis Returns the end Speech Markup mapping for the given attributes.
:Description If an attribute or set of attributes is mapped to a Speech Behavior, this function returns the end markup for the font name. See the Attribute Behavior Table in default.jcf. Note some mappings don't require an end markup tag hence the mapping will be blank.
:Returns String the Speech Markup which will be used to indicate the end of text in this attribute.
:Param Int/iAttributeKey this int must represent the attributes to lookup ored together.
:Category Speech Markup

:function smmGetEndMarkupForColor
:Synopsis Returns the end Speech Markup mapping for the given color.
:Description If a text/background color combination is mapped to a Speech Behavior, this function returns the end markup for the color. See the Color Behavior Table in default.jcf.
:Returns String the Speech Markup which will be used to indicate the end of text in this color. Note that not all behaviors require an end tag.
:Param Int/iTextColor
:Param Int/iBackgroundColor
:Category Speech Markup

:function smmGetEndMarkupForControlState
:Synopsis Returns the end Speech Markup mapping for the given control state.
:Description If a control state is mapped to a Speech Behavior, this function returns the end markup for the control state. See the ControlState Behavior Table in default.jcf. Note that since only sounds or speak item maybe assigned to a control state, you never need to use or get the end markup for control state behaviors.
:Returns String the Speech Markup which will be used to indicate the control state. Note that it is generally unlikely that a control state will be mapped to a behavior requiring an end markup tag.
:Param Int/iControlType (required to determine the appropriate state)
:Param Int/iControlState state of control, see hjconst.jsh for control states.
:Category Speech Markup

:function smmGetEndMarkupForControlType
:Synopsis Returns the end Speech Markup mapping for the given control type.
:Description If a control type is mapped to a Speech Behavior, this function returns the end markup for the control type. See the ControlTypes Behavior Table in default.jcf.
:Returns String the Speech Markup which will be used to indicate the end of the control. Note that not all behaviors require an end tag.
:Param Int/iControlType (must match one of the WT_ constants in hjconst.jsh).
:Category Speech Markup

:function smmGetEndMarkupForFontName
:Synopsis Returns the end Speech Markup mapping for the given font name.
:Description If a font is mapped to a Speech Behavior, this function returns the end markup for the font name. See the Font Name Behavior Table in default.jcf. Note some mappings don't require an end markup tag hence the mapping will be blank.
:Returns String the Speech Markup which will be used to indicate the end of text in this font.
:Param String/sFontName the font name
:Category Speech Markup

:function smmGetEndMarkupForFontSize
:Synopsis Returns the end Speech Markup mapping for the given font size.
:Description If a font size is mapped to a Speech Behavior, this function returns the end markup for the font size. See the Font Size Behavior Table in default.jcf. Note some mappings don't require an end markup tag hence the mapping will be blank.
:Returns String the Speech Markup which will be used to indicate the end of text in this font.
:Param Int/iPointSize the font size marking the upper bound of a given range of font sizes.
:Category Speech Markup

:function smmGetEndMarkupForSingleCap
:Synopsis Returns the end Speech Markup mapping for a single capitalized letter.
:Description This function returns the end markup which will be used for a single capitalized letter.
:Returns String the end Speech Markup which will be used to indicate a single capital letter. Note that some behaviors don't require an end tag and hence this will be blank.
:Category Speech Markup

:function smmGetMarkupForSymbol
:Synopsis Returns the appropriate markup for a symbol.
:Description for example, this function will return &amp; for the & sign.
:Returns String the markup for the given symbol.
:Category Speech Markup

:function smmGetSpeechMarkupTextOptions
:Synopsis Retrieves the text options appropriate for the current jcf settings and supplied output type.
:Description When using the smmMarkupString function, the result of this function maybe used as the TextOptions parameter. This function sets the text options appropriately according to the currently selected jcf option values and Output type.
:Returns Int the bit flags of the appropriate text options for the given output type.
:Param Int/iOutputType the output type to use to retrieve the appropriate text options.
:Category Speech Markup

:function smmGetStartMarkupForAllCaps
:Synopsis Returns the Speech Markup mapping for a capitalized word (or letter group).
:Description This function returns the markup which will be used to introduce a capitalized word or letter group.
:Returns String the Speech Markup which will be used to indicate a capitalized word.
:Category Speech Markup

:function smmGetStartMarkupForAttributes
:Synopsis Returns the Speech Markup mapping for the given attributes.
:Description If an attribute or  set of attributes is mapped to a Speech Behavior, this function returns the start markup for the attributes. See the attributes Behavior Table in default.jcf.
:Returns String the Speech Markup which will be used to indicate the beginning of text in this attribute.
:Param Int/iAttributeKey this int must represent the attributes to lookup ored together.
:Category Speech Markup

:function smmGetStartMarkupForColor
:Synopsis Returns the Speech Markup mapping for the given text/background color combination.
:Description If a text/background color combination is mapped to a Speech Behavior, this function returns the start markup for the color. See the Color Behavior Table in default.jcf.
:Returns String the Speech Markup which will be used to indicate the beginning of text in this color.
:Param Int/iTextColor
:Param Int/iBackgroundColor
:Category Speech Markup

:function smmGetStartMarkupForControlState
:Synopsis Returns the Speech Markup mapping for the given control state.
:Description If a control state is mapped to a Speech Behavior, this function returns the start markup for the control state. See the ControlState Behavior Table in default.jcf.
:Returns String the Speech Markup which will be used to indicate the control state.
:Param Int/iControlType (required to determine the appropriate state).
:Param Int/iControlState state of control, see hjconst.jsh for control states.
:Category Speech Markup

:function smmGetStartMarkupForControlType
:Synopsis Returns the Speech Markup mapping for the given control type.
:Description If a control type is mapped to a Speech Behavior, this function returns the start markup for the control type. See the ControlTypes Behavior Table in default.jcf
:Returns String the Speech Markup which will be used to identify this control type.
:Param Int/iControlType (must map to one of the WT_ constants in hjconst.jsh
:Category Speech Markup

:function smmGetStartMarkupForFontName
:Synopsis Returns the Speech Markup mapping for the given font name.
:Description If a font is mapped to a Speech Behavior, this function returns the start markup for the font name. See the Font Name Behavior Table in default.jcf.
:Returns String the Speech Markup which will be used to indicate the beginning of text in this font.
:Param String/sFontName the font name.
:Category Speech Markup

:function smmGetStartMarkupForFontSize
:Synopsis Returns the Speech Markup mapping for the given font size.
:Description If a font size is mapped to a Speech Behavior, this function returns the start markup for the font size. See the Font Size Behavior Table in default.jcf. Note that the entries mark the upperbound for the font size, so, if there are two consequtive entries, one for 10 points and the next for 20, the first entry means 0 to 10 and the next means 11 to 20.
:Returns String the Speech Markup which will be used to indicate the beginning of text in this font size.
:Param Int/iPointSize point size marking upper bound of sizes in this range.
:Category Speech Markup

:function smmGetStartMarkupForSingleCap
:Synopsis Returns the Speech Markup mapping for a single capitalized letter.
:Description This function returns the markup which will be used for a single capitalized letter.
:Returns String the Speech Markup which will be used to indicate a single capital letter.
:Category Speech Markup

:function smmGetSymbolForMarkup
:Synopsis Returns the symbol for the specified markup.
:Description For example, this function will return the & sign for the markup &amp;
:Returns String the symbol for the given markup.
:Category Speech Markup

:function smmMarkupString
:Synopsis Marks up a string according to a set of text options, attributes etc.
:Description This function marks up a string using information supplied as optional parameters.
:Returns String the string marked up ready for speaking with the say command specifying true for the ContainsMarkup optional parameter
:Param String/sText text to mark up
:Optional
:Param Int/iTextOptions see bit flags defined in hjconst.jsh, TextOptions.
:Param Int/iControlType see wt_ constants.
:Param Int/iControlState see control states in hjconst.jsh.
:Param Int/iAttributes bit flags specifying the attributes of this text, see hjconst.jsh.
:Param String/sFontName the font name of all characters in the string.
:Param Int/iPointSize the size of the font for this text.
:Param Int/iTextColor the color of the text.
:Param Int/iBackgroundColor the backround color of this text.
:Param String/sLanguage the language code for this text.
:Param string/sStyle The style description (eg heading 1, normal, etc) for this text (only optional in 5.10)
:Category Speech Markup

:function smmReplaceSymbolsWithMarkup
:Synopsis Replaces all the symbols in a string with the correct markup.
:Description This function processes a string containing symbols and replaces each occurance of a symbol with the correct markup so that the string maybe enhanced with other markup tags and spoken obeying the markup.
:Returns String the original string with all symbols replaced by appropriate markup.
:Param string/sText Enter the text whose symbols should be replaced by markup symbols.
:Category Speech Markup

:function smmSchemeDefinesBehaviorFor
:Synopsis Determines if the active scheme defines a behavior for any of the specified text option flags.
:Description This function is used to determine if the current scheme defines a behavior for any of the specified text option flags. For example, calling this function with a parameter of toAttributes will return 0 for classic since the classic scheme ignores any text attributes. Calling this function with a parameter of toAttributes with the Proofreading or Classic with Attributes schemes loaded however will return 1.
:Returns int true if the current scheme will act upon the supplied text options, false otherwise.
:Param int iTextOptions any number of text options bitwise ored together (see HJConst.jsh) for the list of text options.
:Category Speech Markup

:function smmSetBehavior
:Synopsis Allows the adjustment of a scheme behavior via scripts.
:Description This function allows the scripter to change a scheme behavior on the fly. the setting is only temporary similar to SetJCFOption  however it is very useful when you need to change the behavior of a scheme programmatically.
:Returns int true if the behavior was successfully changed, false otherwise.
:Param string/sBehaviorTableName the category of behaviors you wish too change. this is taken from the section name in the SMF file (minus the "Behavior table" suffix), for example, if you wish to change an Attribute behavior, the value of this parameter should be set to "Attribute".
:Param string/sKey the key from the behavior table you wish to modify (or add).
:Param int/iBehavior the new behavior, 0 ignore, 1 speak item, 2 play sound, 3 change voice or 4 change language. (See hjconst.jsh).
:Optional
:Param string/sData the new data for the behavior. For example, if you are changing the behavior to change language and you wish to specify the new language, use this parameter to provide the data for the behavior. Note this data corresponds to data1 through data4 in the SMF file depending on the behavior you set. If you do not provide the data, the behavior will inherit the current data from the active scheme.
:Category Speech Markup

:function smmSetDesiredUnitsOfMeasure
:Synopsis Sets the units of measure used for reporting indentation and other measurements.
:Description This function is used to set the units of measure JAWS uses for speaking measurements such as indentation etc.
:Returns void
:Param int iUnit one of smmPixels, smmSpaces, smmPoints, smmMM, smmCM or smmInches.
:Category Speech Markup

:function smmStripMarkup
:Synopsis Strips speech markup from a string.
:Description This function strips all speech markup commands and replaces all markup symbols with their correct symbols.
:Returns String the original string with all markup removed and all &sym; replaced with the correct symbols.
:Param String/sMarkup the string containing markup.
:Category Speech Markup

:function smmToggleTrainingMode
:Synopsis Toggles the Speech and Sounds Manager training mode on and off.
:Description When the Speech and Sounds Manager Training Mode is on, any item which is indicated by a sound or voice change also speaks the item as with the classic scheme. This enables a user of a new scheme to familiarize themself with the sounds and voices chosen to indicate a particular item.
:Returns void
:Param int/bFlag set to 1 to turn training mode on, set to 0 to turn it off.
:Category Speech Markup

:function smmTrainingModeActive
:Synopsis Determines if the Speech and Sounds Manager training mode is on or off.
:Description This function returns 1 if the training mode is on, 0 if it is off.
:Returns int 1 or 0
:Category Speech Markup

:function SpeakPlaceMarkerByIndex
:Synopsis speaks the text at the nth placemarker and optionally moves the cursor to the placemarker.
:Description This functionspeaks the text at the nth placemarker and optionally moves the cursor to the placemarker.
:Returns Int True or False, depending if the nth placemarker was found.
:Param Int/nIndex the 1-based index of the place marker to speak and optionally move to.
:Param Int/bMove True if the cursor should be reloacated to the placemarker, False to speak but not move to the placemarker.
:Category HTML

:function SpeechInUse
:Description Checks to see if speech output is being used.
:Returns Int TRUE if synthesizer is active, FALSE otherwise.
:Category Voices

:function SpeechOff
:Description Causes the synthesizer to be muted. This is particularly useful when you need to free the synthesizer so that a wave file can be played. You can reverse this action with SpeechOn
:Category Voices

:function SpeechOn
:Description UnMutes the synthesizer. Reverses the action of SpeechOff.
:Category Voices

:function SpellFromCursor
:Synopsis Spellls the contents of the current line from the cursor to the end of the line.
:Description This function spells the contents of the current line from the cursor to the end  of the line.
:Returns Void
:Category Screen Text

:function SpellLine
:Synopsis Spellls the contents of the current line.
:Description This function spells the contents of the current line.
:Returns Void
:Category Screen Text

:function SpellString
:Description Spells a string of text. This is similar to the SayString function. However, it spells the string letter by letter instead of speaking words.
:Param string Type the text that is to be spelled, or specify a variable name or script function that can provide the required text string. Text strings that are typed must be enclosed within quotation marks.
:Category Strings

:function SpellToCursor
:Synopsis Spellls the contents of the current line upto the cursor.
:Description This function spells the contents of the current line upto the cursor.
:Returns Void
:Category Screen Text

:function SpellWord
:Description Spells the word at the active cursor.
:Category Screen Text

:function SpellWordPhonetic
:Synopsis Spells the word at the cursor using phonetics.
:Description This function spells the word at the active cursor using Phonetic alphabet.
:Returns Void
:Category Screen Text

:function StartJAWSTaskList
:Description The JTL allows the user to minimize, maximize, close, start, and switch to applications
:Returns Int The value is 0 if JAWSTaskList.dll can not be loaded, or 1 if the function is called from the dll successfully.
:Category User Interaction

:function StartOfRow
:Description When inside a table or spreadsheet, moves the active cursor to the start of the current row.
:Returns Int TRUE if the cursor moved, FALSE otherwise.
:Category Tables

:function StepOutOfCurrentElement
:Synopsis Moves to the beginning or end of the ancestor element.
:Description This function moves to the beginning or end of the ancestor element, effectively stepping out of the element or moving up one level in the element hierarchy. This can be used for stepping out of a nested list either to the beginning or end of the nested list. Repeated calls will keep stepping out of the element at that level until you reach the top level body. The single parameter specifies whether you are moved to the end or beginning of the element. A second optional parameter allows you to specify how many levels you are stepped out. The default is 0 which means the function will determine the appropriate number of levels for the current element.
:Returns Int true if the function relocated the virtual cursor, false otherwise.
:Param Int/bFindTheEnd true to move to the end or false to move to the beginning.
:Optional
:Param Int/nLevels how many levels to step out. Use a value of 0 to force the function to automatically determine the appropriate number of levels to step out. For example, if you are in a table cell and you want to step out of the table then nLevels should be at least 2 because the first level will only refer to the row containing the cell element.
:Category HTML

:function StopSpeech
:Description Silences the synthesizer. Same as pressing the CTRL key.
:Category Voices

:function stringChopLeft
:Synopsis Chops the first part of a string by the specified number of characters.
:Description This function chops the first part of a string by the specified number of characters and returns the remainder.
:Returns String chopped by supplied number of characters.
:Param String/sStr string to chop.
:Param Int/iChop by how many characters.
:Category Strings

:function stringChopRight
:Synopsis Chops the last part of a string by the specified number of characters.
:Description This function chops the last part of a string by the specified number of characters and returns the remainder, ie the first part.
:Returns String chopped by supplied number of characters.
:Param String/sStr string to chop.
:Param Int/iChop by how many characters.
:Category Strings

:function StringCompare
:Synopsis Compares two string with case sensitivity optional
:Returns int 0 if the two strings are equal, a negative number if the first string is less than the second, or a number greater than 0 if the first string is greater than the second.
:Param string the first string in the comparison.
:Param string the second string in the comparison.
:Optional
:Param int true if the compare is to be case sensitive, false otherwise.
:Category Strings

:function StringContains
:Description Determines whether a specified text string is contained within another text string.
:Returns Int An integer is returned to indicate the position in string 1, where the two strings begin to match. If a value of 5 is returned, this means that the string in parameter 2 is present in parameter 1 and the matching characters begin at the fifth character in the string. If a value of 0 is returned, this means that the string in parameter 2 is not contained within the string in parameter 1.
:Param string This parameter specifies the string that is to be searched. The search starts at the beginning of this string. Type the text string, type a variable name, or choose a script function. Text strings must be enclosed within quotation marks.
:Param string  This parameter contains the string you are trying to locate. Type the text string, type a variable name, or choose a script function. Text strings must be enclosed within quotation marks.
:Category Strings

:function StringContainsChars
:Synopsis determines if a string contains any of the characters in the second string
:Description this function returns TRUE if any of the characters in string 2 appear in string 1.
:Returns int True if string1 contains any of the characters in string2
:Param string/sStr the string to search
:Param string/sCharList the list of characters to look for in sStr
:Category Strings

:function StringDiff
:Synopsis Retrieves the parts of a string which precede or follow the contents of a  second string.
:Returns String A concatenation of the parts of s1 which come before and after the contents of s2.  If s2 is not contained within s1, then the empty string is returned.
:Param String/s1 The string to be searched.
:Param String/s2 The string to search for.
:Category Strings

:function StringIsBlank
:Synopsis Determines if a string is blank.
:Description This function returns true if the specified string only contains spaces, tabs or newline characters. It returns false if the string contains any printable character. This is useful for determining if strings returned from the object model of an application are blank as far as JAWS speaking is concerned.
:Returns Int true or false.
:Param String/sStr the string to test.
:Category Strings

:function StringLeft
:Description Extracts a specified number of leftmost characters from a string.
:Returns String The string that is extracted from strString.
:Param String/strString The string from which the leftmost characters will be extracted.
:Param Int/nCount The number of leftmost characters that will be extracted.
:Category Strings

:function StringLength
:Description Used to find the length of a string.
:Returns Int Returns an integer value specifying the length of the string.
:Param String The string for which the length is requested.
:Category Strings

:function StringLower
:Description Converts a mixed case string to all lower case.
:Returns String The converted string.
:Param String/strString The string to be converted.
:Category Strings

:function StringMixedCaseToMultiword
:Synopsis Converts a mixed case word to multiple words.
:Description This function converts a mixed case string to multiple words. For example ScreenSensitiveHelp is converted to Screen Sensitive Help.
:Returns String the mixed case string with spaces inserted before each capital letter.
:Param String/sMixedCase the string containing mixed case words.
:Category Strings

:function StringReplaceChars
:Synopsis Replaces all characters in the character list with the specified character.
:Description For example stringReplaceChars("hello", "lo","-") would result in he---
:Returns string the resultant string
:Param string/sSource the string to search
:Param string/sCharList string of characters you want to replace occurrances of.
:Param string/sChar the char to replace each of the characters in sCharList if found.
:Category Strings

:function StringReplaceSubstrings
:Synopsis Replaces occurances of one substring with another.
:Description For example, StringReplaceSubstrings("hello there everyone", "there", "") would result in hello everyone.
:Returns string the resultant string
:Param string/sSource source string
:Param string/sSubstringToReplace the substring in source to replace.
:Param string/sReplacement the string to replace any occurances of above string with (maybe null to remove occurances).
:Category Strings

:function StringReverse
:Synopsis Reverses a string.
:Description This function reverses a string, useful when you need to look at the differences between the ends of two strings.
:Returns String the reversed string.
:Param String/sSource string to reverse.
:Category Strings

:function StringRight
:Description Extracts a specified number of rightmost characters from a string.
:Returns String The string that is extracted from strString..
:Param String/strString The string from which the rightmost characters will be extracted.
:Param Int/nCount The number of rightmost characters that will be extracted.
:Category Strings

:function StringSegment
:Description When a string contains delimiters, StringSegment can be called to extract a segment of the string. One is the index of the first string. As of JAWS 7.0, negative numbers extract segments from the right end of the string.  So -1 will return the last segment, -2 the second to the last etc.
:Returns String The string segment specified by nIndex.
:Param String/strString The string that is delimited by some character or characters.
:Param String/strDelimiters The delimiter or set of delimiters. This string must be enclosed in quotation marks.
:Param Int/nIndex The index of the segment to be retrieved. One is the index of the first segment. -1 is the index of the last segment
:Category Strings

:function StringSegmentCount
:Description Retrieves a count of  segments in a string.
:Returns Int The count of segments in the string
:Param String/strString The string that is delimited by some character or characters.
:Param String/strDelimiters The delimiter or set of delimiters. This string must be enclosed in quotation marks.
:Category Strings

:function StringSegmentIndex
:Description When a string contains delimiters, StringSegmentIndex can be called to determine the index of a particular segment.
:Returns Int the 1-based index of the specified segment (0 if the segment wasn't found).
:Param String/strString The string that is delimited by some character or characters.
:Param String/strDelimiters The delimiter or set of delimiters. This string must be enclosed in quotation marks.
:Param String/strSegment the segment whose index you want.
:Optional
:Param Int/iExactMatch true if the segment should match exactly, false to just check that the segment contains the specified string.
:Category Strings

:function stringStripAllBlanks
:Synopsis Strips all blanks from a string.
:Description this function strips leading, embedded and trailing blanks from a string.
:Returns String The string without blanks.
:Param String/sStrTOStrip string containing blanks to strip.
:Category Strings

:function StringToHandle
:Description Converts a string value to a handle.  It is assumed that the string contains atextual representation of an actual handle value.
:Returns Handle The converted string.
:Param string The string to be converted to a handle.
:Category Strings

:function StringToInt
:Description Converts a string value to an integer and returns the integer value.
:Returns Int The newly created integer.
:Param string The string to be converted to an integer.
:Category Strings

:function StringTrimCommon
:Synopsis Compares two strings and trims common characters from either the start, the end or both start and end returning the difference between the strings by reference.
:Description This function compares two strings and trims the common characters from either the start, the end or both the start and end. The user specifies which end to trim by setting the third parameter to 0 for both ends, 1 for the start or 2 for the end. For example, if string 1 is "hello world" and string 2 is "hello fred", StringTrimCommon(s1, s2, 1) would return world in s1 and fred in s2 and the return value would be 1. If the strings are identical then the function returns FALSE since there is nothing left after trimming common characters.
:Returns int TRUE if the function trimmed common characters and either s1 or s2 contain something after the comparison, FALSE if s1 and s2 are identical.
:Param string/ByRef/s1 the first string to compare. Note after calling this function this parameter is replaced by the piece of s1 which is not contained in s2.
:Param string/ByRef/s2 the second string to compare. Note after calling this function, s2 is replaced by the piece of s2 which is not contained in s1.
:Optional
:Param int/nTrimWhat 0 both start and end, (default), 1 trim start, 2 trim end.
:Category Strings

:function StringTrimLeadingBlanks
:Synopsis Removes leading blanks from a string.
:Description strips leading blanks from a string.
:Returns String the string with leading blanks trimmed.
:Param String/sSource string to trim.
:Category Strings

:function StringTrimTrailingBlanks
:Synopsis Removes trailing blanks from a string.
:Description strips trailing blanks from a string.
:Returns String the string with trailing blanks trimmed.
:Param String/sSource string to trim.
:Category Strings

:function StringUpper
:Description Converts a mixed case string to all upper case.
:Returns String The converted string.
:Param String/strString the string to be converted.
:Category Strings

:function SubString
:Description Extracts part of a string from another string. It could be used to read a portion of the information that appears on a status line.
:Returns String Provides a substring of text for use by other functions.
:Param string Type a string to be processed, or specify a variable name or script function that can provide the text string. Text strings must be enclosed within quotation marks.
:Param Int Type a number to indicate the position of the first character in the substring which is to be extracted. The index number of the first character in the string is 1.
:Param Int Type an integer to indicate the number of characters that are to be extracted from the string. If the int is greater than the number of characters remaining in the string, then the number is silently rounded down.
:Category Strings

:function SwitchToConfiguration
:Description When this function is called, the currently loaded set of configuration files is unloaded from memory and the specified set of configuration files is loaded in its place.
:Returns Int TRUE if the argument passed in is a valid string (not "").  FALSE if an invalid string is passed into the function.
:Param String/strConfiguration The base name of the set of Configuration files to load.  Calling this function with "MyConfigurations" for example, would load the Configuration, Keymap, Script, Dictionary, Graphics, Symbols, and Frame files that have base name "MyConfiguration."
:Category Settings

:function SwitchToPreviousApp
:Synopsis Switches to the nth most recently used application window.
:Description This simulates holding down the ALT key and pressing TAB a specified number of times.
:Optional
:Param int/nTimes The number of times the Tab key should be simulated.  This defaults to 1, which which is the equivalent of pressing ALT+TAB.
:Category System

:function SwitchToScheme
:Synopsis Switches to the specified Speech Manager Scheme.
:Description This function switches to the specified Speech Manager Scheme. If the scheme exists then the function returns TRUE, if it doesn't it returns FALSE and no scheme change occurs.
:Returns Int TRUE or FALSE.
:Param string sScheme the scheme name (no extention or path required).
:Category Speech Markup

:function SwitchToScriptFile
:Description When this function is called, the currently loaded binary script file (A file with a .JSB extension) is unloaded from memory and one of the two script files specified by the functions parameters is loaded in its place. The first parameter to the function is the name of the first JSB file you wish for JFW to attempt to load into memory and the second parameter gives the name of an alternative binary script file that will only be loaded if the first file cannot be found.
:Param String/strScriptFileName1 The name of the binary script file you wish to be loaded into memory.  This parameter must be a script file name in quotes or the name of a variable in which the script file name is stored.  This parameter must be the script file name with or without a .jsb extension.  An attempt to use a .jss extension in the file name will result in an error and a warning dialog box.
:Param String/strScriptFileName2 The name of the binary script file you wish to be loaded into memory if the first file does not exist.  This parameter must be a script file name in quotes or the name of a variable in which the script file name is stored.  This parameter must contain the script file name with or without a .jsb extension.  An attempt to use a .jss extension in the file name will result in an error and a warning dialog box.
:Category Scripts

:function SynthCount
:Synopsis Retrieves the number of synthesizers configured in JAWS
:Returns Int the number of synthesizers configured in JAWS
:Category Settings

:function SynthDisplayLoadErrors
:Synopsis Retrieves whether or not JAWS displays an error to the user when the synthesizer at the specified index fails to load
:Returns Int TRUE if the error should be displayed, FALSE otherwise
:Param int/nIndex the index of the synthesizer
:Category Settings

:function SynthDriver
:Synopsis Retrieves the driver name of the synthesizer at the specified index
:Returns String The driver name of the requested synthesier, or "" if there is not a synthesizer at that index.
:Param int/nIndex the index of the synthesizer whose driver name is to be retrieved
:Category Settings

:function SynthDriverInformation
:Synopsis Retrieves the driver information of the synthesizer at the specified index
:Returns String The driver information string of the requested synthesier, or "" if there is not a synthesizer at that index.
:Param int/nIndex the index of the synthesizer whose driver information string is to be retrieved
:Category Settings

:function SynthLongName
:Synopsis Retrieves the descriptive name of the synthesizer at the specified index
:Returns String The descriptive name of the requested synthesier, or "" if there is not a synthesizer at that index.
:Param int/nIndex the index of the synthesizer whose name is to be retrieved
:Category Settings

:function SynthName
:Synopsis Retrieves the name of the synthesizer at the specified index
:Returns String The name of the requested synthesier, or "" if there is not a synthesizer at that index.
:Param int/nIndex the index of the synthesizer whose name is to be retrieved
:Category Settings

:function SynthPort
:Synopsis Retrieves the port name of the synthesizer at the specified index
:Returns String The port name of the requested synthesier, or "" if there is not a synthesizer at that index.
:Param int/nIndex the index of the synthesizer whose port name is to be retrieved
:Category Settings

:function SynthPortString
:Synopsis Retrieves the port string of the synthesizer at the specified index
:Returns String The port string of the requested synthesier, or "" if there is not a synthesizer at that index.
:Param int/nIndex the index of the synthesizer whose port string is to be retrieved
:Category Settings

:function SysGetDate
:Description Obtains a string representing the given date in the specified format.
:Returns String A string representing the given date, or the current system date if no month, day and year are provided.
:Optional
:Param String/strFormat The desired date format. For example "dd/MM/yyyy."
:Param Int/month A value between 1 and 12.
:Param Int/day A value between 1 and the number of days in the month of interest.
:Param Int/year Four digits year number.
:Category System

:function SysGetTime
:Description Obtains a string representing the given time in the specified format.
:Returns String A string representing the given time, or the current system time if no hour, minute and second are provided.
:Optional
:Param String/strFormat The desired time format. For example "hh:mm tt."
:Param Int/hour A value between 0 and 23.
:Param Int/min A value between 0 and 59.
:Param Int/sec A value between 0 and 59.
:Category System

:function SysTrayGetItemCount
:Description Obtains the number of items in the System Tray.
:Returns Int iIem count.
:Category System

:function SysTrayGetItemToolTip
:Description This function is used in ListTaskTrayIcons to obtain the ToolTip that corresponds to a specific Task tray icon. This function takes a single parameter, the index of the Task tray icon for which the ToolTip is desired. It returns a string value that is the text of the ToolTip in question.
:Returns String The text of the tool tip of the specified Task tray icon.
:Param Int/nIdx The index of the Task tray icon in question.
:Category System

:function SysTrayMoveToItem
:Description Moves the JAWS cursor to the location of an item in the System Tray.
:Returns Int TRUE if Successful.
:Param Int/ItemNumber the index number of the item.
:Category System

:function TabKey
:Synopsis Passes the TAB key through to the application.
:Description The TAB key is passed to the application. If the Virtual PC cursor is active, it is moved to the next link or control in the tab order.
:Category Keyboard

:function tbGetItemRect
:Description Gets the bounding rectangle of the specified item in a ToolBar.
:Returns Int TRUE if the bounding rectangle is successfully retrieved.
:Param Handle/hwnd The handle of the ToolBar of interest.
:Param Int/Item index of the item desired.
:Param Int/nLeft/ByRef The left edge of the bounding rectangle after the function is called.
:Param Int/nRight/ByRef The right edge of the bounding rectangle after the function is called.
:Param Int/nTop/ByRef The top edge of the bounding rectangle after the function is called.
:Param Int/nBottom/ByRef The bottom edge of the bounding rectangle after the function is called.
:Category Dialog Controls

:function tbGetItemState
:Description Retrieves the state of an item on a ToolBar.  Refer to the return states for more information.
:Returns Int a combination of state flags.   See the TBSTATE_* values in HJCONST.JSH.
:Param Handle/hwnd window handle of the ToolBar.
:Param Int/item 1-based index of the item.
:Category Dialog Controls

:function tbGetItemText
:Description Retrieves the text of an item in a Toolbar.
:Returns String The contents of the requested item.  If the item is a graphic, text will only be returned if that graphic has a JAWS graphic label.
:Param Handle to the window containing a ToolBar.
:Param Int 1-based index of the item in the ToolBAr.
:Category Dialog Controls

:function TimedMessageBox
:Synopsis Displays a message box for a given length of time.
:Description Use to assert a message box for a given amount of time while awaiting processing.
:Param Int/nButtons Enter the desired MB_ constants from HjConst.jsh, or simply 0 for default behavior.  You can use the ICONERROR or other ICON constants to provide known graphics and system beeps.
:Param String/strText Enter the text of the message box window.
:Param String/strTitle Enter the text for the title of the window.
:Param Int/iTimer Enter the time in milliseconds to have the message box stay on the screen.
:Category User Interaction

:function ToggleHomeRow
:Description Toggles Home Row mode ON/OFF. Home Row mode is a shifted state for the keyboard. It is analogous to the NUM LOCK on the numeric keypad. When it is on, the alphabet keys and number keys can be used to perform script functions. When Home Row mode is turned OFF, the keys perform their standard functions.
:Returns Int  "ON" = 1, "OFF" = 0.
:Category Utility

:function ToggleKeyboardLogging
:Description Logs key messages as they are processed by our keyboard engine.  The log output is dumped into the JAWS directory keystrokes.log file.
:Returns Int TRUE if keyboard logging is turned on, otherwise FALSE.
:Category Keyboard

:function ToggleLocatorMode
:Description Toggles the current state of the MAGic Locator.
:Returns Void
:Optional
:Param Int 1 if MAGic  should restore the original cursor position if exiting the locator.
:Category MAGic

:function ToggleOutputType
:Synopsis cycles the Spoken or Braille output type message level
:Description This function cycles the spoken or Brailled output type message length from 0 (don't speak/Braille, 1 use long messages or 2 use short messages). You determine whether the cycling affects Speech or Braille by using the second optional parameter. If this parameter is not specified the function defaults to cycling the Speech message length.
:Returns int the new value
:Param int/iOutputType the Output Type to cycle.
:Optional
:Param int/iDestination 0 speech, 1 Braille
:Category Braille Settings

:function ToggleRestriction
:Description This toggles JAWS between restricted and unrestricted mode. These modes do not affect the movement of the PC cursor. When unrestricted mode is used, the other cursors can be freely moved within the active application window. When restricted mode is used, the movement of these cursors is limited to a child window. When the function is used, it returns a constant value representing the new setting. ON indicates that the restriction is on, and OFF indicates that the restriction is off.
:Returns Int  "ON" = 1, "OFF" = 0.
:Category Cursors

:function TopOfColumn
:Description When inside a table or spreadsheet, moves the active cursor to the top of the current column.
:Returns Int TRUE if the cursor moved, FALSE otherwise.
:Category Tables

:function TrapKeys
:Description Turns Trap key mode On or Off. When Trap Key mode is on, any keys not attached to scripts are simply ignored and not passed on to the current application. The primary use for this feature is in the Keyboard Help, where keys not attached to scripts should be ignored.
:Param Int TRUE to enable trapping, FALSE to disable it.
:Category Keyboard

:function TurnOffFormsMode
:Description Used to turn off forms mode.
:Category HTML

:function TurnOnFormsMode
:Description Used to turn on forms mode after it has been manually turned off. Unlike calling EnterKey, this function simply re-enables forms mode regardless of what kind of control currently has focus. Note this is only available in JAWS 5.0 international, build 5.00.760 or higher.
:Category HTML

:function tvCollapse
:Description Collapses the currently selected treeview node.
:Returns Int TRUE if successful, FALSE otherwise.
:Param Handle The TreeView window.
:Category Dialog Controls

:function tvExpand
:Description Expands the currently selected treeview node.
:Returns Int TRUE if successful, FALSE otherwise.
:Param Handle The TreeView window.
:Category Dialog Controls

:function tvGetFocusItemExpandState
:Description Use this function to get the expanded/collapsed state of the focus item in a treeview. This function does not use MSAA for determining the treeview item state.
:Returns int -1 if the focus treeview item has no children, 1 if the focus treeview item is expanded, 0 if the focus treeview item is collapsed.
:Param handle The handle of a treeview.
:Category Dialog Controls

:function tvGetFocusItemText
:Description Retrieves the text of the focus item for a treeview.
:Returns string The text of the focus item in the tree view.
:Param handle The handle of a treeview.
:Category Dialog Controls

:function tvGetItemStateImageIndex
:Description Use this function to distinguish between the differring state graphics that may be placed beside items in a tree view.
:Returns int the state image index for the currently active treeview item. This value should change as the state graphic changes on the screen.
:Param handle The handle of the treeview window.
:Category Dialog Controls

:function tvSelectNextItem
:Description Selects the next visible item depending on the current selected item.
:Returns Int TRUE if successful, FALSE otherwise.
:Param Handle The TreeView window.
:Category Dialog Controls

:function tvSelectPriorItem
:Description Selects the prior visible item depending on the current selected item.
:Returns Int TRUE if successful, FALSE otherwise.
:Param Handle The TreeView window.
:Category Dialog Controls

:function TypeCurrentScriptKey
:Synopsis Passes the attached key through to the application.
:Description The key attached to the current script is passed through to the application.
:Category Scripts

:function TypeKey
:Description Simulates a keystroke.  Unlike TypeString, TypeKey translates the message constant at runtime.
:Returns Int TRUE if the string is successfully simulated.
:Param string A message constant containing a keystroke name.
:Category Keyboard

:function TypeString
:Description Used to simulate a string of keystrokes. For example: to send a group of keystrokes through to the application simulating the string "test," you could either enter the line {t}{e}{s}{t}, or you could use TypeString ("test").
:Returns Int The number of keystrokes simulated.
:Param string The string of characters that will be sent to the underlying application. This parameter must be enclosed in quotation marks.
:Category Strings

:function UnScheduleFunction
:Description Used to cancel a ScheduleFunction call.
:Returns Int TRUE if the call was found and cancelled, otherwise returns FALSE.
:Param Int/ID The value returned by the ScheduleFunction call.
:Category Scripts

:function UpCell
:Description When inside a table or spreadsheet, moves the active cursor to the same cell in the prior row.
:Returns Int TRUE if the cursor moved, FALSE otherwise.
:Category Tables

:function UserBufferActivate
:Synopsis Activates the User Virtual Buffer.
:Description The User Virtual buffer may be used as a replacement focus for graphical or other windows where the real focus is not meaningful. the User Virtual Buffer maybe populated with text. Each piece of text may have an associated function assigned to it so that when Enter or the Left Mouse button is presssed in this text, the function will be called.
:Returns Int true if the buffer was activated, false if already active.
:Optional
:Param Int/iTrapKeys true to trap (default) false to allow all keys to be passed to the application.
:Category Virtual Viewer

:function UserBufferActivateEx
:Synopsis Activates the User Virtual Buffer with parameters.
:Description The User Virtual buffer may be used as a replacement focus for graphical or other windows where the real focus is not meaningful. the User Virtual Buffer maybe populated with text. Each piece of text may have an associated function assigned to it so that when Enter or the Left Mouse button is presssed in this text, the function will be called.  This function is like UserBufferActivate except that it accepts parameters to allow a script to identify the user buffer.  The passed values are stored for return by UserBufferWindowName, UserBufferWindowType, UserBufferWindowTypeCode, and UserBufferWindowControlID.  When UserBufferDeactivate is called these values are copied for return by UserBufferPrevWindowName, etc.
:Returns Int true if the buffer was activated, false if already active.
:Param String/sName The name that you want to assign the virtual buffer.
:Param String/sType The window type that you want to assign the virtual buffer.  It has to be a string.
:Param Int/iTypecode The type code for the Virtual buffer as an Integer.
:Param Int/iControlId The Control Id for the Virtual Buffer as an Integer.
:Category Virtual Viewer

:function UserBufferAddText
:Synopsis Adds the specified text and associated function to the User Virtual Buffer.
:Description This function adds the text to the Virtual User Buffer along with the specified function. The function's display name is used in the links dialog as a human readable name in place of the code function name.
:Returns Int true if the text was added, false if not.
:Param String/sText The text to be added to the buffer (if this doesn't end in a newline character then one will be added)
:Optional
:Param String/sFunctionString the function name including any parentheses and parameters to be called when the Enter key or mouse click occurs in the associated text.
:Param String/sFunctionDisplayName the name to be used in the list links dialog when it is invoked when the User Virtual Buffer is active.
:Param String/sFontName the name of the font used for ins+f when located in this text.
:Param Int/iPointSize the point size of the font used for ins+f when located in this text.
:Param Int/iAttributes the attribute flags used for ins+f when located in this text for.
:Param Int/iTextColor the text colour.
:Param Int/iBackgroundColor the background color.
:Param Int/iAddLineBreak add a line break to this string automatically, true by default.
:Param int/ct Control Type (see WT_XX constants in HJConst.jsh (JAWS 7.0 and higher)
:Param int/cs Control State, see CTRL_STATE constants in HJConst.jsh (JAWS 7.0 and higher)
:Category Virtual Viewer

:function UserBufferClear
:Synopsis Clears the user buffer of text and associated functions.
:Description This function clears the User Virtual Buffer ready to be repopulated with text and functions.
:Returns Void
:Category Virtual Viewer

:function UserBufferDeactivate
:Synopsis Deactivates the User Virtual Buffer.
:Description When this occurs, JAWS will track the normal focus rather than allow navigation in the User Virtual Buffer.
:Returns Int true if the buffer was deactivated, false if not active.
:Category Virtual Viewer

:function UserBufferGetFontInfo
:Synopsis Returns the User Buffer's font information.
:Description This function  returns the font information set by the user for all text added to the buffer for which this information is not specified.
:Returns Int true if get was successful.
:Param String/byRef/sFontName font name.
:Param Int/byRef/iPointSize point size.
:Param Int/byRef/iAttributes attributes of text eg attrib_bold & attrib_italic etc.
:Param Int/byRef/iTextColor color value for text color.
:Param Int/byRef/iBackgroundColor color value for background color.
:Category Virtual Viewer

:function UserBufferGetLength
:Synopsis Gets the number of characters in the User Buffer.
:Description This function returns the number of characters in the User Buffer.
:Returns Int number of characters (including newlines).
:Category Virtual Viewer

:function UserBufferGetText
:Synopsis Gets the text in the user buffer.
:Description This function returns the text in the user buffer. It is useful when you want to save and restore the contents.
:Returns String the text.
:Category Virtual Viewer

:function UserBufferIsActive
:Synopsis Determines if the User Virtual Buffer is active.
:Description This function determines if the User Virtual Buffer is currently active.
:Returns Int true or false.
:Category Virtual Viewer

:function UserBufferIsTrappingKeys
:Synopsis Determines if the User Virtual Buffer is trapping keys.
:Description This function determines if the User Virtual Buffer is currently trapping keys.
:Returns Int true or false.
:Category Virtual Viewer

:function UserBufferPrevWindowName
:Synopsis Retrieves the previous window name that was assigned to a virtual buffer.
:Description This function retrieves the window name that was assigned to the previously active virtual buffer.  It is the value returned by UserBufferWindowName prior to the last invocation of UserBufferDeactivate.
:Returns String Returns the window name of the previous virtual buffer.
:Category Virtual Viewer

:function userBufferPrevWindowType
:Synopsis Retrieves the Window type name assigned to the previous virtual buffer.
:Description This function retrieves the Window type name that was assigned to the previous virtual buffer.
:Category Virtual Viewer

:function UserBufferSetFontInfo
:Synopsis Allows user to specify default font name, point size, attribs and text/background colors.
:Description This function  allows user to specify default font name, point size, attribs and text/background colors, so this info doesn't have to be added for each segment of text.
:Returns Int true if set was successful.
:Param String/sFontName font name.
:Param Int/iPointSize point size.
:Param Int/iAttributes attributes of text eg attrib_bold & attrib_italic etc.
:Param Int/iTextColor color value for text color.
:Param Int/iBackgroundColor color value for background color.
:Category Virtual Viewer

:function UserBufferWindowName
:Synopsis Retrieves the window name that was specified by the UserBufferActivateEx function.
:Description This function retrieves the window name that was specified by the UserBufferActivateEx function.
:Returns string the user buffer window name
:Category Virtual Viewer

:function userBufferWindowType
:Synopsis Retrieves the Window type name that was specified by the UserBufferActivateEx function.
:Description This function retrieves the Window type name that was specified by the UserBufferActivateEx function.
:Category Virtual Viewer

:function UsingRemotePACMateBX
:Synopsis determines if JAWS is running in an remote PAC Mate BX session.
:Returns int TRUE if running in a remote PAC Mate BX session.
:Category Keyboard

:function VerbosityLevel
:Description Changes the verbosity setting. Settings include Beginner, Intermediate, and Advanced. The verbosity setting determines how much descriptive information is to be spoken as you use Windows.
:Category Settings

:function WasTextAlreadyAppended
:Synopsis Checks if a text is already in the clipboard.
:Description Checks if text is already in the clipboard.
:Returns Int TRUE if already exists.
:Param String/sSourceText The current collection of appended text.
:Param String/sTextToFind The text that is about to be appended.
:Category Clipboard

:function While
:Description The While operator marks the beginning of a While loop. The While statement must be followed by a conditional statement enclosed in parenthesis. While loops allow certain actions to be performed repeatedly as long as the conditions indicated after the While statement return true. Every While loop must end with an EndWhile statement. Loops can be used to save space and programming time. However they can also be dangerous. It is important to ensure that the condition is met at least once (or else the statements between the while and the EndWhile never get run) and that the condition eventually returns false. Otherwise an infinite loop is created and it will cause your computer to crash.
:Category Control Flow

:function WindowActivatedEvent
:Synopsis This function is triggered when a window is activated.
:Description This function is generally triggered when focus changes because of the opening or closing of a top-level window, such as when a dialog appears or disappears.
:Param handle/hWindow Handle of the window just activated.
:Category Window

:function WindowVirtualView
:Synopsis Turns the virtual view for a window on or off
:Description This function turns the virtual view for a window on or off. The virtual view is presented as a virtual document as implemented by one of the FSDomSrv dlls.
:Returns int true if the window was successfully virtualized or restored, FALSE otherwise
:Param handle/hWnd the window handle you wish to virtualize or restore to non-virtual view
:Param int/bEnable TRUE to enable the virtual view, FALSE to restore the view
:Optional
:Param string/sDllName the name of the DLL to use with the Document Server, if not specified, the MSAA dll wil be used.
:Category Object Model and MSAA

