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

sapgui_set_checkbox

Example: sapgui_set_checkbox General Object Functions

Selects or clears a checkbox.

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

If isSelected is "True" then sapgui_set_checkbox selects the checkbox. If isSelected is "False", the box is cleared.

Return Values

This function returns LR_PASS (0) on success or LR_FAIL (1) on failure.

Parameterization

You can parameterize all string (char type) arguments.