Parsing Functions

SapGuiGetOkCode Function
Retrieves text of the OK code text field.

SapGuiGetStatusBarText Function
Retrieves the current text of the SapGui status bar.

SapGuiGetStatusBarType Function
Retrieves the current type of the status bar control.

SapGuiGetText Function
Retrieves the text of a label or edit control.

SapGuiIsCheckboxChecked Function
Determines whether a SapGui check box control is checked.

SapGuiIsRadioButtonSelected Function
Determines whether a specified radio button is selected.

SapGuiIsTabSelected Function
Determines whether a specified tab is active.

SapGuiGridGetCellData Function
Returns the value of a specified cell from a grid control.

SapGuiGridGetColumnCount Function
Counts the number of columns of a SapGui grid control.

SapGuiGridGetColumnName Function
Retrieves the name of a specified column of a SapGui grid control.

SapGuiGridGetColumnOrder Function
Returns an iterator to a collection that contains all the column identifiers in the order in which they are currently displayed.

SapGuiGridGetCurrentCellColumn Function
Returns the name of the current cell's column.

SapGuiGridGetCurrentCellRow Function
Returns the name of the current cell's row.

SapGuiGridGetRowCount Function
Returns the number of rows of a SapGui grid control.

SapGuiGridGetSelectedCells Function
Collection of selected cells contains strings, each of which has the format “<index of the row>,<column identifier>”, such as “0,CARRID”.

SapGuiGridGetSelectedColumns Function
Selected columns are available as a collection of strings.

SapGuiGridIsCheckboxChecked Function
Determines whether grid cell's check box is checked.

SapGuiObjectFree Function
Frees the memory that was allocated for a handle.

SapGuiObjectGetBoolean Function
Reads the return value of a previous SapGuiObjectInvokeMethod call and provides it as type boolean.

SapGuiObjectGetCollection Function
Reads the return value of a previous function call and returns it as a collection iterator.

SapGuiObjectGetControlId Function
Provides the control id of a SAPGUI object.

SapGuiObjectGetLong Function
Reads the return value of a previous call of the SapGuiObjectInvokeMethod function.

SapGuiObjectGetProperty Function
Reads an object’s property.

SapGuiObjectGetPropertyBoolean Function
Reads an object’s property.

SapGuiObjectGetPropertyLong Function
Reads an object’s property.

SapGuiObjectGetObject Function
Reads the return value of a pior call to SapGuiObjectInvokeMethod.

SapGuiObjectGetPropertyObject Function
Reads an object’s property where the value to be read is an object.

SapGuiObjectGetString Function
Reads the return value of a previous SapGuiObjectInvokeMethod call and provides it as a string.

SapGuiObjectGetType Function
Returns the “type” and the “subtype” property of a SAPGUI object.

SapGuiObjectSetBoolean Function
Pushes a parameter of type boolean onto the parameter stack for the next SapGuiObjectInvokeMethod call.

SapGuiObjectSetLong Function
Pushes a parameter of type long onto the parameter stack for the next SapGuiObjectInvokeMethod function call.

SapGuiObjectSetObject Function
Pushes an object onto the parameter stack for the next method invocation with SapGuiObjectInvokeMethod.

SapGuiObjectSetProperty Function
Sets an object’s property.

SapGuiObjectSetPropertyObject Function
Sets an object’s property which is of type object.

SapGuiObjectSetString Function
Pushes a variable of type string onto the parameter stack for the next call of SapGuiObjectInvokeMethod call.

SapGuiIteratorFetchNext Function
Moves the iterator to the next position.

SapGuiObjectInvokeMethod Function
Invokes a method for the passed object.

SapGuiIteratorHasMore Function
Determines whether there are more entries in a collection.

SapGuiIteratorRelease Function
Frees the resources that were allocated for an iterator.

SapGuiIteratorGetCount Function
Determines the number of elements in a collection.

SapGuiIteratorGetObject Function
Provides the value of the iterator’s current position.

SapGuiIteratorGetObjectAt Function
Reads and provides the value of a collection at a specified position.

SapGuiIteratorGetValue Function
Provides the value of the iterator’s current position.

SapGuiIteratorGetValueAt Function
Reads and provides the value of a collection at a specified position.

SapGuiGetCollection Function
Reads the return value of a previous SapGuiInvokeMethod or SapGuiGetProperty call and provides it as a collection iterator.

SapGuiGetComboboxEntries Function
Provides an iterator for the combobox entries.

SapGuiGetHandleFromControlId Function
Returns a handle for the control specified.

SapGuiGetPropertyCollection Function
Reads the return value of a previous call of SapGuiInvokeMethod and provides the value as a collection.