SAP GUI Functions (SAPGUI) > Alphabetical List of Functions > sapgui_is_checkbox_selected

sapgui_is_checkbox_selected

Example: sapgui_is_checkbox_selected Verification and Data Retrieval Functions

Returns the checkbox state.

int sapgui_is_checkbox_selected( const char *description, const char *checkBoxID, [args,] LAST );
description User entered text to aid in understanding script
checkBoxID Object ID Strings
args Optional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_is_checkbox_selected verification function returns the status of a checkbox. The function is True if the checkbox is selected and False if it is cleared.

Return Values

This function returns True (-1) or False (0).

Parameterization

You can parameterize all string (char type) arguments.