This document covers the following topics:
An environment that has once been connected during the current Natural Studio session. This includes the local environment also. Remote environments are only available with Natural Single Point of Development. See also Remote Development Using SPoD.
The following properties are available:
Used to navigate to the parent interface of this interface.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| HANDLE OF OBJECT | VT_DISPATCH (INatAutoEnvironments) | Get only |
Used to navigate to the root interface.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| HANDLE OF OBJECT | VT_DISPATCH (INatAutoStudio) | Get only |
TRUE if this is the local environment.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| L | VT_BOOL | Get only |
TRUE if this is the active environment.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| L | VT_BOOL | Get only |
TRUE if this environment is currently connected.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| L | VT_BOOL | Get only |
The name of the environment. This name can be used in the method
INatAutoEnvironments::Item
to identify a specific environment uniquely.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR |
The host name of the development server.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR | Get only |
The port number of the development server.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| I4 | VT_I4 | Get only |
The alias name of the environment as displayed in the library workspace.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR | Get only |
A command line containing additional dynamic parameters under which the environment is running.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR | Get only |
The user ID under which the environment is mapped.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR | Get only |
Returns an interface to the NATPARM parameters of
this environment.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| HANDLE OF OBJECT | VT_DISPATCH (INatAutoNatParm) | Get only |
Returns an interface to the system variables of the environment.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| HANDLE OF OBJECT | VT_DISPATCH (INatAutoNatsvar) | Get only |
The following methods are available:
Makes this environment the active one. An environment cannot explicitly be deactivated. An environment is implicitly deactivated when another one is activated.
This method is not applicable to environments that are disconnected.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| Visible | L | VT_BOOL | Optional |
- Visible
This parameter can be used to temporarily activate a different environment and then reactivate the previous environment, without affecting the user interface.
If set to TRUE or not specified, the newly activated environment is selected in the library workspace.
If set to FALSE, the previously active environment stays selected.
Disconnects the environment and closes the development server session. If this environment was the active one, the previously active environment gets activated.
This method is not applicable to the local environment.
Reestablishes the connection to a previously disconnected environment. Activates the connected environment.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| Password | A | VT_BSTR | Optional |
| Quiet | L | VT_BOOL | Optional |
| IgnoreWarnings | L | VT_BOOL | Optional |
- Password
The password of the user ID under which the environment was previously connected.
- Quiet
If set to FALSE or not specified, the Map Environment dialog is shown and is preset with the given parameters.
If set to TRUE, the Map Environment dialog is not shown.
- IgnoreWarnings
If set to FALSE or not specified, warnings that occur during connecting are treated like errors.
If set to TRUE, warnings are ignored.
Unmaps the environment, disconnects it and closes the development server session. If this environment was the active one, the previously active environment gets activated.
This method is not applicable to the local environment.