Share this page

# sapgui_status_bar_get_text

Status Bar Functions

Retrieves the status bar text.

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

outputParamName | Parameter to store retrieved text.
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_text data retrieval function gets the text from the status bar and stores it in parameter outputParamName. The entire text as the user sees it is retrieved, including both fixed text and parameters.

## 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_text to retrieve the status bar notification after saving a transaction.

    // Send the transaction

    sapgui_press_button("Save (Ctrl+S)",

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

    sapgui_select_active_window("wnd[1]", LAST );

    sapgui_press_button("Hold",

        "usr/btnSPOP-VAROPTION1", LAST );

    sapgui_select_active_window("wnd[0]");

    //The text of the status bar is "Standard PO held under the number 4500010751".

    sapgui_status_bar_get_text("paramText", LAST );

    // The value of parameter 1 in the status bar is "Standard PO".

    sapgui_status_bar_get_param("1", "param1", LAST );

    //The value of parameter 2 in the status bar is "4500010751".

    sapgui_status_bar_get_param("2", "param2", LAST );

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: