GetEnvironmentVariable

The GetEnvironmentVariable component retrieves the value of an environment variable from the current process.

Screenshot

Ports

The GetEnvironmentVariable component exposes the Control In, Control Out, Data In and Data Out ports by default.

Port Description
ControlIn Must be connected to the Control Out port of one or more components.
ControlOut Can be connected to the Control In port of another component or the default end component.
Data In Specifies the name of a system environment variable or a user environment variable (string).
Data Out Returns the value of the specified environment variable (string).

Properties

To edit the properties of the GetEnvironmentVariable component, in the Properties window, change the required property. You can edit the following properties.

Property Description
Search Search for the respective property.
Delay After Execution Specifies the wait time (in seconds) after the action is performed.
Delay Before Execution Specifies the wait time (in seconds) before the action is performed.

Example

Let us consider an example.

Screenshot

To retrieve the value of an environment variable:

  1. In the Toolbox, expand Utilities and expand Environment.
  2. Drag the GetEnvironmentVariable component and drop it on the Design surface.
  3. To specify the environment variable whose value is to be retrieved, double-click the variable box and enter the name of the required variable.
  4. To override the existing data source, right-click variable.
  5. Click Override and change the data source.

    Note

    To learn more about overriding the data source of the data port, refer the Override section.

  6. To enable display of the retrieved value, you can add a MessageBox component to the activity.

    To add the MessageBox component:

    • In the Toolbox, expand the General.
    • Expand the MessageBox component, drag Show component and drop it on the design surface.
      Repeat to add the second MessageBox component.
  7. Connect the control ports and the data ports in the activity.
  8. In the toolbar, click Run.
    The messagebox displays the value of the specified environment variable.

    Screenshot