Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Use the GetMainWindowHandle component

Retrieve the window handle of a main window of an active process by using the GetMainWindowHandle component in RPA Desktop Design Studio. This component accepts the Process ID as input and returns the Integer value of the specified process.

Before you begin

Role required: none

About this task

You can configure the properties for the GetMainWindowHandle component. For more information about these properties, see Properties of the System Process components.

Procedure

  1. In the Toolbox pane, navigate to Utilities > System Process.

  2. Drag the GetMainWindowHandle component to the Design surface.

  3. To configure the input fields, see Configure port properties.

  4. Connect the data and control ports of the GetMainMainWindowHandle to the corresponding ports of the other component as described in the following table.

    Port typePurpose of connectionMandatory?
    Data In (ProcessId)Takes the process ID of the window as a string from a previously executed component.Yes
    Data Out (Integer)Returns the Windows handle of the specified process and passes to the next component.Yes
    Control InConnects to the Control Out port of one or more components.Yes
    Control OutConnects to the Control In port of another component or the default end component.No
  5. To test the component, under the DESIGN tab, click Run.

Parent Topic:System process