About this Manual

This document is written for the programmer developing a SQL interface to a relational or non-relational database to allow SQL access from PCs and other platforms using Microsoft OLE DB, ODBC, or .NET compliant interfaces and Sun Microsystems JDBC compliant interface.

This document provides detailed description of Application Programming Interface exposed to the IP developer for using the facilities of the Database Access Manager (DAM) and the API the interface provider implements.

Specifically, this document covers the following topics:

·          Setting up the development environment.

·          API exposed by the Interface Provider – this is the inteface that must be implemented to OpenAccess enable a data source.

·          API of the Database Access Manager (DAM).

·          API for working in SQL pass through mode.

·          API for tracing and memory magnagement.

This document is divided into 7 chapters.  Chapter 1 details the required steps to set up the development environment to develop an IP.  Chapter 2 lists the API the IP exposes to the DAM.  Chapter 3 lists APIs that an IP can use when using the DAM for SQP parsing and execution.  Chapter 4 details the development of drivers working in SQL pass through mode. Chapter 5 details trace and memory functions the IP should use.  Chapter 6 lists the error codes and associated messages used within OpenAccess.  It also provides a list of messages a user would see and what they mean.  Chapter 7 details the project settings when using Microsoft Visual Studio.

Please refer to the OpenAccess SDK Programmer’s Guide for details on the operations of OpenAccess and how to write and IP.

Refer to the OpenAccess SDK Installation Guide for details on installing the driver development kit.

Refer to the OpenAccess SDK Configuration Guide for details on configuring the OpenAccess run-time components.

Notation Convention

The courier font is used for system-dependent keywords and commands to be typed by the user.  The pipe character ‘|’ is used as a shortcut notation and separator between menus, sub-menus, and items.  As an example:  ‘File | Open’ means the Open option from the File menu.

Getting Technical Support

Technical support is available by telephone and Email.  Please provide the OpenAccess product version and the platform you are running on when calling/writing for technical support.