Share this page
sapgui_status_bar_get_param
| Example: sapgui_status_bar_get_param | Status Bar Functions |
Retrieves parameter from status bar text.
int sapgui_status_bar_get_param( const char *paramIndex, const char *outputParamName, [args,] LAST );
| paramIndex | Index of the parameter in the status bar. |
| outputParamName | Retrieved value. |
| 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_param data retrieval function gets the parameter in position paramIndex from the status bar and stores it in parameter outputParamName.
This function only returns a value if the status bar text consists of parameters from which SAP builds the text. If the status bar contains a simple constant text message outputParamName contains an empty string.
The index paramIndex is a number from 1 to 8. If there are fewer than 8 parameters in the status bar text outputParamName contains an empty string when paramIndex is greater than the number of 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.
