Previous Topic: Remote DB2 AccessNext Topic: API Variable Types

Using Windows and UNIX APIs › UNIX Encyclopedia API

UNIX Encyclopedia API

The UNIX Encyclopedia API provides access from a program running on a Client Server Encyclopedia-supported UNIX platform to the models stored in a CSE on the same platform (local) or another platform (remote) with the same database type. On the UNIX platform, Oracle is the only supported remote database type.

UNIX programs that use the Encyclopedia API are linked using API static libraries that contain all of the Encyclopedia API functions. These programs depend on shared libraries that implement communication services and access to the selected database. The read-only libraries are installed with the Encyclopedia Servers, the update libraries are installed only when the Update API is installed.

UNIX Encyclopedia
Libraries

Description

encyapi.a

Static read-only API library

updapi.a

Static Update API library, replaces encyapi.a in update programs

eapiclt.a

Static client functions library

eapimds.a

Static Message Dispatcher access library

eapinet.a

Static network support functions library

eapisrv.a

Static server functions library

eapiutl.a

Static utility functions library

eapisqc.a

Static Oracle database access library

sqlintf.a

Shared library common database access interface library

libcti<ver>.sl *

Shared library TCP / IP communications functions, HP-UX

libcdb<ver>.sl *

Shared library database access functions, HP-UX

libcti<ver>.a *

Shared library TCP / IP communications functions, AIX

libcdb<ver>.a *

Shared library database access functions, AIX

* <ver> is replaced by a version number

The demonstration program executables and source for the read-only API are installed with the Encyclopedia Servers. The demonstration program executables and source for the Update API are installed with the Update API component.

UNIX Encyclopedia
API Demo Program

Description

apidemo

Read-only API demo executable

epidemo.c

Read-only API source code

upddemo

Update demo executable

upddemo.c

Update demo source code

eapi.sh

Shell script builds apidemo, and upddemo if installed.

You can compile and link the demo programs by running the script file eapi.sh from a UNIX shell.

sh eapi.sh

The script file requires that the environment variable IEFCSGEN is defined and referenced the cse/bin directory. The script builds the read-only demo, and if it finds that the Update API is installed, the script builds the update demo as well. You should read this file to see the compiler options used to compile and link applications that use the Encyclopedia Read-only or Update API.