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

sapgui_status_bar_get_type

Example: 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.