Share this page

# sapgui_status_bar_get_type

Status Bar Functions

Retrieves the state of the status bar: success, warning or error.

    int sapgui_status_bar_get_type( const char *outputParamName, [args,] LAST );

outputParamName | Retrieved text describing type of bar.
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_status_bar_get_type data retrieval function gets the state of the status bar and saves it in output_param_name. The function tests the outcome of the previous action.

The value of outputParamName after a successful call to sapgui_status_bar_get_type is one of the following literal strings: "Success", "Warning", or "Error".

## 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_status_bar_get_type to check on the success of a transaction.

    // Send the transaction

    sapgui_press_button("Save (Ctrl+S)",

        "tbar[0]/btn[11]", LAST );

    sapgui_select_active_window("wnd[1]");

    sapgui_press_button("Hold",

        "usr/btnSPOP-VAROPTION1", LAST );

    sapgui_select_active_window("wnd[0]");

    //The value of "StatusBarType" after the call is "Success".

    sapgui_status_bar_get_type("StatusBarType", LAST );

    // Output is "Status of last action is 'Success'."

    lr_output_message("Status of last action is '%s'.",

        lr_eval_string("{StatusBarType}");

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: