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"
checkBoxIDObject ID Strings
argsOptional 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.

Example

The following example uses sapgui_set_checkbox to select a checkbox.

sapgui_set_checkbox("V scroll attribute",
    "True", 
    "usr/chkDEMO_TPROP-V_SCROLL", 
    BEGIN_OPTIONAL, 
        "AdditionalInfo=info1033", 
    END_OPTIONAL);