Share this page

# sapgui_get_active_window_title

Verification and Data Retrieval Functions

Retrieves the title of the active window.

    int sapgui_get_active_window_title( const char *output_param_name, [args,] LAST );

output_param_name | The VuGen parameter containing the title of the window
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_get_active_window_title data retrieval function gets the name of the active window in the current SAP session and saves it in output_param_name.

## 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_set_property to set the text within the command window to "dwdm". The script then verifies the window title by retrieving it using sapgui_get_active_window_title and writing to a parameter ParamName1.

Copy code

    Action() {
    sapgui_select_active_window("wnd[0]");
         sapgui_set_property("tbar[0]/okcd",
                 "text", "dwdm", LAST );
         // Verification - not recorded function
         sapgui_get_active_window_title("title_name_param", LAST );
        // Output: "Window title = SAP Easy Access"
         lr_output_message
            (lr_eval_string("Window title = {title_name_param}"));
        return 0;
    }

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: