Share this page

# Verification and Data Retrieval Functions

There are two types of object information functions, verification functions and date retrieval functions. Neither type can be recorded, but you can add them to enhance the script.

Verification functions typically return a True or False status.

Some verification functions check successful completion execution of a previous function. Some check object status.

You can avoid script crashes by using these functions to check if necessary conditions exist before calling a function.

Data retrieval functions retrieve the value of an object attribute and store the value in the output parameter.

Click on a function or more information:

sapgui_get_active_window_title | Gets the title of the active window
sapgui_get_ok_code | Retrieves the Command field text.
sapgui_get_property | Gets the property of a SAP object
sapgui_get_property_of_active_object | Retrieves a property of the active object
sapgui_get_status_bar_text | Gets the text in the status bar.
sapgui_get_text | Gets the text from an object.
sapgui_grid_get_cell_data | Retrieves the text from a grid cell.
sapgui_grid_get_current_cell_column | Retrieves the column number of a grid's current cell.
sapgui_grid_get_current_cell_row | Retrieves the row number of a grid's current cell.
sapgui_grid_get_columns_count | Retrieves the number of columns in the grid.
sapgui_grid_get_rows_count | Retrieves the number of rows in the grid.
sapgui_grid_is_checkbox_selected | Checks the state of a checkbox in a grid.
sapgui_is_checkbox_selected | Checks if a checkbox is selected.
sapgui_is_object_available | Checks if an object exists.
sapgui_is_object_changeable | Checks if an object is enabled and writable.
sapgui_is_radio_button_selected | Checks if a radio button is selected.
sapgui_is_tab_selected | Checks if a tab is selected.
sapgui_status_bar_get_param | Gets a parameter from the status bar.
sapgui_status_bar_get_text | Gets text from the status bar.
sapgui_status_bar_get_type | Retrieves status bar information: Success, Warning, or Error.
sapgui_table_get_text | Retrieves the text in a table cell.
sapgui_table_is_column_selected | Checks whether a table column is selected.
sapgui_table_is_checkbox_selected | Checks the state of a checkbox in a table.
sapgui_table_is_radio_button_selected | Checks the state of a radio button in a table.
sapgui_table_is_row_selected | Checks if a table row is selected.
sapgui_tree_get_item_text | Gets the text of a tree item.
sapgui_tree_get_node_text | Gets the text of a tree node.
sapgui_tree_is_checkbox_selected | Checks if a tree check box is selected.

For a complete list, see the Alphabetical listing of SAP Functions.

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: