Oracle Call Interface Getting Started for Windows Platforms

Library

Product

Contents

Index

Building OCI Applications

• Project Files
• Compiling OCI Applications
• Linking OCI 32-bit Applications
• Linking OCI 16-bit Applications

Project Files

Project files are often used to assist in building application programs. They guide and control the steps necessary to precompile, compile, and link programs.

MS Visual C/C++ and Borland C/C++ project files help keep executable versions of your programs current when you modify dependent files. These project files are provided with Windows NT/95 sample programs. The MS Visual C/C++ and Borland C/C++ project files:

• call the compiler to generate an .OBJ file
• call the resource compiler to generate an .RES file from an .RC file
• call the linker to create an .EXE file

For more information on the build process, refer to the applicable product documentation for your development environment.

Compiling OCI Applications

To compile the resulting .C source file, switch to the development environment and build the application. Some compiler options are required while others are optional. All options are case-sensitive and are listed below.

Microsoft Compiler Option (16-bit)

Use the following options when compiling an Oracle database application using Microsoft C:

• /AL--Uses the large memory model.
• /c--Compiles the source code only and creates an .OBJ file (required).
• /Gw--Generates entry and exit code sequences for a microsoft Windows application.
• /Zp--Packs structure members on the specified byte boundary for all code containing microsoft Windows structures.

Refer to the documentation provided with your development environment to ensure that all applicable options are selected.

Microsoft Debugging Option (16 and 32-bit)

To debug your application using Microsoft CodeView, use the normal debugging option. For more information, see your Microsoft documentation.

• /Od--Turns off optimization.
• /Zi--Includes line number and symbolic information in the object file.

Refer to the documentation provided with your development environment to ensure that all applicable options are selected.

Borland Compiler Options (16 and 32-bit)

Use the following options when compiling an Oracle database application using Borland C.

• /ml--Uses the large memory model (16-bit only).
• /c--Compiles the source code only and creates an .OBJ file (required).
• /WS--Makes the target a Windows NT/95 .EXE that uses smart callbacks, with explicit functions exportable.
• /I--Sets include file search paths. Oracle recommends that you include \bc4\include and \orant (or orawin95, or orawin)\oci73\c\include on the search path.

Borland Debugging Options

To debug your application using Borland Turbo Debugger, use the normal debugging option. For more information, see your Borland documentation.

• /v--Includes debugging information in the object file.

Linking OCI 32-bit Applications

Link Libraries

When you link OCI applications, you use the following types of library files:

Oracle Libraries

Oracle libraries are required for OCI and/or applications that access an Oracle database.

Runtime Libraries

Runtime libraries are created when you install your C compiler. Runtime libraries are required for any C application, including applications that access the Oracle database.

OCI Dynamic-Link Libraries

The OCI calls are implemented in DLL files that Oracle provides. To use the DLLs, you must link your application with the import libraries (.LIB files) that correspond to the OCI DLLs. Also, you must make sure that the OCI DLL files are installed on the workstation that is using your OCI application.

Applications linked with DLLs provide the following benefits over static libraries:

• Multiple applications can share the same DLL module, conserving disk space and memory.
• Import libraries can load more than one DLL module.
• You can update DLL modules by overwriting the DLL files. When you do this, it is not necessary to relink applications that access the DLL module.

The required library file is:

Select the Correct Runtime Library In order to build a Windows NT/95 application, select the appropriate runtime library for the application you are building. See the compiler documentation for your compiler. Also, include the OCIAPR.H header file in your source code. See your compiler's documentation for more information.

Linking Windows NT Applications

To link a Windows NT/95 application, you must use the runtime libraries installed with the C compiler.

Resource File Before linking a Windows NT/95 application, you must build resources such as menus, dialog boxes, cursors, and character strings. You can create resources by using Microsoft's App Studio or Borland's Resource Workshop. For further information, consult your compiler's documentation.

Microsoft Visual C/C++ It is recommended that you include \MSDEV\LIB on the search path if using MSVC 4.x.

Borland Link Options Use the following options to link an Oracle Database application.

• /L--Specifies library search paths. It is recommended that you include \BC5\LIB and %ORACLE_HOME%\OCI73\LIB on the search path.
• /v--Adds Borland symbolic debugging information to the executable file (optional).

OCI Header Files

To use OCI, include OCI header files in your programs. The files are as follows:

• OCIAPR.H--Declares and gives prototype information for OCI functions. Use for ANSI C compatibility.
• OCIDFN.H--Common header file for OCI C sample programs. Declares the cursor and logon data area structure.
• ORATYPES.H--Defines C types used by OCI programs.
• OCIDEM.H--OCI demonstration header for CDEMO1 . . . CDEMO6.

OCI Program Calls

The Programmer's Guide to the ORACLE Call Interfaces documents the cursor data area definition and the logon data area definition.

Running OCI Windows NT Applications

WINOCI.C

This program adds new employee records to the personnel database. The program checks the integrity of the database. You can enter as many employee names as you want and perform the SQL commands by selecting the appropriate buttons in the Employee Record box.

The WINOCI program displays a graphical window. Select Connect from the Oracle menu to display the logon dialog box. Type the userid SCOTT, the password TIGER, and the name of the remote Oracle7 Server. Click on OK to connect with the Oracle database.

The following lists the buttons and their definitions available in the programs:

• Select--Displays the first record from EMP
• Fetch Next--Displays the next record from EMP
• Delete--Deletes the current record
• Update--Updates the record after changes to column values
• Clear--Clears the display
• Insert--Inserts a blank record into the current table




Note Oracle recommends that you use Clear, enter values for the buttons, then use Select to enter the new record.

• Commit--Commits changes made to the EMP table
• Rollback--Undoes changes made to the EMP table since the last COMMIT
• Exit--Exits the sample application

To analyze how an OCI for Windows NT/95 application is built, examine the Microsoft project file by using a text editor to view the steps required to compile, create resources, and link a Windows NT/95 application.

Linking OCI 16-bit Applications

Link Libraries

When you link OCI applications, you use the following types of library files:

Oracle Libraries

Oracle libraries are required for OCI and/or applications that access an Oracle database.

Runtime Libraries

Runtime libraries are created when you install your C compiler. Runtime libraries are required for any C application, including applications that access the Oracle database.

OCI Dynamic-Link Libraries

The OCI calls are implemented in DLL files that Oracle provides. To use the DLLs, you must link your application with the import libraries (.LIB files) that correspond to the OCI DLLs. Also, you must make sure that the OCI DLL files are installed on the workstation that is using your OCI application.

Applications linked with DLLs provide the following benefits over static libraries:

• Multiple applications can share the same DLL module, conserving disk space and memory.
• Import libraries can load more than one DLL module.
• You can update DLL modules by overwriting the DLL files. When you do this, it is not necessary to relink applications that access the DLL module.

The required library files are listed in the following tables:

Select the Correct Runtime Library In order to build a Windows application, select the appropriate runtime library for the application you are building. For example, if you are using the medium model, link with the medium model runtime library. In addition, designate a minimum of 30K of stack space to perform Oracle database operations. Also, include the OCIAPR.H header file in your source code. See your compiler's documentation for more information.

Linking Windows Applications

To link a Windows application, you must use the runtime libraries installed with the C compiler.

You must also link with a module definition file, as described in your compiler's documentation. Windows applications that access an Oracle database require no special module statements. The module definition file for the sample Windows application is named WINSAM.DEF.

The following module statements must appear in the file:

Example:

The following example presents the contents of a typical module definition file:

Resource File

Before linking a Windows application, you must build resources such as menus, dialog boxes, cursors, and character strings. You can create resources by using Microsoft's App Studio or Borland's Resource Workshop. For further information, consult your compiler's documentation.

Microsoft C Link Options

The following options can be used to link an Oracle database application using Microsoft C:

Borland Link Options

The following options can be used to link an Oracle database application using Borland:

OCI Header Files

To use OCI, include OCI header files in your programs. The files are as follows:

• OCIAPR.H--Declares and gives prototype information for OCI functions. Use for ANSI C compatibility.
• OCIDFN.H--Common header file for OCI C sample programs. Declares the cursor and logon data area structure.
• ORATYPES.H--Defines C types used by OCI programs.
• OCIDEM.H--OCI demonstration header for CDEMO1 . . . CDEMO6.

OCI Program Calls

The Programmer's Guide to the ORACLE Call Interfaces documents the cursor data area definition and the logon data area definition.

Running OCI Windows Applications

WINOCI.C

This program adds new employee records to the personnel database. The program checks the integrity of the database. You can enter as many employee names as you want and perform the SQL commands by selecting the appropriate buttons in the Employee Record box.

The WINOCI program displays a graphical window. Select Connect from the Oracle menu to display the logon dialog box. Type the userid SCOTT, the password TIGER, and the name of the remote Oracle7 Server. Click on OK to connect with the Oracle database.

The following lists the buttons and their definitions available in the programs:

• Select--Displays the first record from EMP
• Fetch Next--Displays the next record from EMP
• Delete--Deletes the current record
• Update--Updates the record after changes to column values
• Clear--Clears the display
• Insert--Inserts a blank record into the current table




Note Oracle recommends that you use Clear, enter values for the buttons, then use Select to enter the new record.

• Commit--Commits changes made to the EMP table
• Rollback--Undoes changes made to the EMP table since the last COMMIT
• Exit--Exits the sample application

To analyze how an OCI for Windows application is built, examine the Microsoft project file by using a text editor to view the steps required to compile, create resources, and link a Windows application.

Prev Next

Copyright © 1996 Oracle Corporation. All Rights Reserved.

Library

Product

Contents

Index