DISC

Contents | What's New | Quick Links

 

OmniAccess API

Introduction

Software Installation

Concepts and Design

Designing Applications

Omnidex Environments

SQL Reference

Omnidex API's

Utilities

Interfaces

Performance Guide

Troubleshooting Guide

Appendix

 

 

Connect to an Environment

 

When connecting to an Omnidex Environment, an instance is established.

An instance is an identifier that represents the unique connection by a user to an Omnidex Environment Catalog. It is a signed integer that is returned to the instance parameter of the Status array. This value is then passed to other api routines subsequently called.

The instance establishes not only the data in the environment, but the type of access (read, read/write, or exclusive) that user has to the data. Each instance also contains information about the connection such as the type of access and other configuration options.

OmniAccess API

Status Array

Select List

Functions

Connect to an Environment

Open a Cursor

Manage Data Across Cursors

Manage Large Lists of Records

Convert Data Types

Undetermined Criteria

To establish an instance, call oaconnect and specify a compiled Omnidex Environment Catalog filespec (or TurboIMAGE database name) through the environment parameter. Specify the connect options through the options parameter, including user and password, as appropriate.

It is possible to open several catalogs concurrently and thereby establish several environment instances in the same application. This is useful when data is organized in several separate environment catalogs.

 

Close an Instance

When an application no longer requires access to an Omnidex Environment Catalog, it should close the instance before terminating.

If the instance remains open after the application terminates, it may interfere with other applications and users trying to access the environment catalog. Although this is unlikely, it is a good practice to close instances when the application finishes using them.

Omnidex Client applications should close instances to free up memory on the PC and to close socket connections to the server.

To close an instance, call oadisconnect and pass the value returned to the instance parameter of oaconnect. Closing an instance automatically closes any cursors open for the environment established for that instance. When performed from a client application, it also closes any socket connections between a client and server.

top

Dynamic Information Systems Corporation - Omnidex Version 3.8 Build 6 J15.03-Copyright © 2003

DISC | Documentation Home