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

INatAutoSystem

This document covers the following topics:


Purpose

Gives access to certain system functions and to the available development environments and applications.

Top of page

Properties

The following properties are available:

Parent

Used to navigate to the root interface.

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

Studio

Used to navigate to the root interface.

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

Environments

Used to navigate to the INatAutoEnvironments interface.

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

Applications

Used to navigate to the INatAutoApplications interface.

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

Sysmain

Used to create a new instance of the INatAutoSysmain interface.

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

Top of page

Methods

The following methods are available:

Quit

Terminates Natural Studio.

SysCreateGuid

Creates a global unique ID (GUID). A plug-in might need this method when generating a class.

Parameters

Name Natural Data Format Variant Type Remark
Return value A VT_BSTR  
Return value

A fresh global unique ID (GUID) in registry format (that is: enclosed in curly braces). Returns an empty string, if the creation failed.

CMPALUTL

Used to call the development server through the utility protocol. Currently the utility protocol is only used internally by Software AG products.

Parameters

Name Natural Data Format Variant Type Remark
Return value I4 VT_I4  
UtilityID I2 VT_I2 By value
BufferLength I4 VT_I4 By value
Buffer A VT_BSTR By reference
Return value

Depends on the specific utility being called.

UtilityID

The utility being called.

BufferLength

The length of the data buffer passed in Buffer.

Buffer

The data buffer passed to and returned from the utility. The contents of the buffer on input and output depend on the utility being called. The utility protocol requires that the buffer be large enough to hold the maximum expected result of the utility request. This size depends on the utility being called.

Logon

Used to perform a logon to a specific library in the active environment.

Parameters

Name Natural Data Format Variant Type Remark
Library A VT_BSTR By value
Fnr I4 VT_I4 Optional
DBnr I4 VT_I4 Optional
Library

The library to logon to.

Fnr, DBnr

The file number and database number of the system file the library belongs to. Usually these parameters need not be specified, because the system file is determined by the library name.

Top of page