Version 6.3.13 for Windows
 —  Extending Natural Studio with Plug-ins  —

INatAutoApplications

This document covers the following topics:


Purpose

Collection of applications available on the current application server. Applications and the application server are only available with Natural Single Point of Development. See also Remote Development Using SPoD.

Top of page

Properties

The following properties are available:

Parent

Used to navigate to the parent interface of this interface.

Natural Data Format Variant Type Remark
HANDLE OF OBJECT VT_DISPATCH (INatAutoSystem) Get only

Studio

Used to navigate to the root interface.

Natural Data Format Variant Type Remark
HANDLE OF OBJECT VT_DISPATCH (INatAutoStudio) Get only

Count

The number of applications in the collection.

Natural Data Format Variant Type Remark
I4 VT_I4 Get only

ActiveApplication

Returns the currently active application. Returns NULL-HANDLE if no application is active.

Natural Data Format Variant Type Remark
HANDLE OF OBJECT VT_DISPATCH (INatAutoApplication) Get only

AppServerEnvironment

Returns the application server environment.

Natural Data Format Variant Type Remark
HANDLE OF OBJECT VT_DISPATCH (INatAutoEnvironment) Get only

Top of page

Methods

The following methods are available:

Item

Returns a specific application from the collection.

Parameters

Name Natural Data Format Variant Type Remark
Return value HANDLE OF OBJECT VT_DISPATCH (INatAutoApplication)  
Index

I4
A

VT_I4
VT_BSTR

 
Return value

The application identified by the value specified in Index.

Index

Identifies a specific application in the collection. This can be either the index of the application in the collection (a value between 1 and Count) or the name of the application.

Add

Creates a new application, adds it to the collection, maps it, connects it and activates it. Returns the application.

Parameters

Name Natural Data Format Variant Type Remark
Return value HANDLE OF OBJECT VT_DISPATCH (INatAutoApplication) Optional
Name A VT_BSTR  
BaseApplication L VT_BOOL Optional
Host A VT_BSTR Optional
Port I4 VT_I4 Optional
MainframeApplication L VT_BOOL Optional
Profile A VT_BSTR Optional
ProfileDBnr I4 VT_I4 Optional
ProfileFnr I4 VT_I4 Optional
ProfilePassword A VT_BSTR Optional
Quiet L VT_BOOL Optional
IgnoreWarnings L VT_BOOL Optional
Return value

The newly added application.

Name

The name of the application.

BaseApplication

If set to TRUE, a base application is created. Otherwise a compound application is created. Creating a base application requires at least the specification of Host and Port.

Host

The host name of the development server. Must be specified for base applications.

Port

The port number of the development server. Must be specified for base applications.

MainframeApplication

If set to TRUE, a mainframe application is created.

Profile

The profile under which the development server is running.

ProfileDBnr

The profile database number of the development server.

ProfileFnr

The profile file number of the development server.

ProfilePassword

The profile password of the development server.

Quiet

If set to FALSE or not specified, the Map Application dialog is shown and is preset with the given parameters.

If set to TRUE, the Map Application dialog is not shown.

IgnoreWarnings

If set to FALSE or not specified, warnings that occur during mapping are treated like errors.

If set to TRUE, warnings are ignored.

Top of page