sapgui_status_bar_get_param

Retrieves parameter from status bar text.

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

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.

Example

The following example uses sapgui_status_bar_get_param to retrieve the parameters from a 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]");

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 );