What Is the Oracle Call Interface?
Total Page:16
File Type:pdf, Size:1020Kb
Oracle Call Interface Getting Started Release 9.2 for Windows March 2002 Part No. A95497-01 Oracle Call Interface Getting Started, Release 9.2 for Windows Part No. A95497-01 Copyright © 1995, 2002 Oracle Corporation. All rights reserved. Contributors: Eric Belden, Janis Greenberg, Herbert Kelly, Helen Slattery, Ravi Thammaiah, and Bob Thome. The Programs (which include both the software and documentation) contain proprietary information of Oracle Corporation; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent and other intellectual and industrial property laws. Reverse engineering, disassembly or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this document is error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation. If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on behalf of the U.S. Government, the following notice is applicable: Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial computer software" and use, duplication, and disclosure of the Programs, including documentation, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer software" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR 52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065. The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and Oracle Corporation disclaims liability for any damages caused by such use of the Programs. Oracle is a registered trademark, and Oracle Store, Oracle8i, Oracle9i, SQL*Plus, and PL/SQL are trademarks or registered trademarks of Oracle Corporation. Other names may be trademarks of their respective owners. Contents Send Us Your Comments .................................................................................................................... v Preface........................................................................................................................................................... vii Audience ................................................................................................................................................ viii Organization.......................................................................................................................................... viii Related Documentation ....................................................................................................................... viii Conventions............................................................................................................................................. x Documentation Accessibility .............................................................................................................. xv What’s New in Oracle Call Interface?....................................................................................... xvii New Features in Oracle Call Interface for Release 9.0.1................................................................ xviii New Features in Oracle Call Interface for Release 8.1.5................................................................ xviii OCI Release 7.x Functions ................................................................................................................. xviii Oracle9i Release 2 (9.2) Deprecated Components........................................................................... xix 1 Introduction to Oracle Call Interface What is the Oracle Call Interface? ................................................................................................... 1-2 What is Included in the OCI Package?........................................................................................... 1-2 Oracle Directory Structure ................................................................................................................ 1-2 Sample Programs ................................................................................................................................ 1-3 2 Building OCI Applications Writing OCI Applications ................................................................................................................. 2-2 iii Compiling OCI Applications ........................................................................................................... 2-2 Linking OCI Applications ................................................................................................................ 2-3 oci.lib............................................................................................................................................... 2-3 Client DLL Loading When Using LoadLibrary()..................................................................... 2-4 Running OCI Applications............................................................................................................... 2-4 The Oracle XA Library ....................................................................................................................... 2-4 Compiling and Linking an OCI Program with the Oracle XA Library ............................... 2-5 Using XA Dynamic Registration ................................................................................................ 2-5 Adding an Environmental Variable for the Current Session.......................................... 2-6 Adding a Registry Variable for All Sessions ..................................................................... 2-6 XA and TP Monitor Information ................................................................................................ 2-7 Oracle C++ Call Interface Methods Specific to Windows NT................................................ 2-7 Using the Object Type Translator and the INTYPE File Assistant.......................................... 2-10 Index iv Send Us Your Comments Oracle Call Interface Getting Started, Release 9.2 for Windows Part No. A95497-01 Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this document. Your input is an important part of the information used for revision. ■ Did you find any errors? ■ Is the information clearly presented? ■ Do you need more information? If so, where? ■ Are the examples correct? Do you need more examples? ■ What features did you like most? If you find any errors or have any other suggestions for improvement, please indicate the document title and part number, and the chapter, section, and page number (if available). You can send com- ments to us in the following ways: ■ Electronic mail: [email protected] ■ FAX: (650) 506-7365 Attn: Oracle Database for Windows Documentation ■ Postal service: Oracle Corporation Oracle Database for Windows Documentation Manager 500 Oracle Parkway, Mailstop 1op6 Redwood Shores, CA 94065 USA If you would like a reply, please give your name, address, telephone number, and (optionally) elec- tronic mail address. If you have problems with the software, please contact your local Oracle Support Services. v vi Preface This guide describes only the features of Oracle Call Interface (OCI) that apply to the Windows NT, Windows 2000, Windows XP, and Windows 98 operating systems. Information on Oracle9i Personal Edition software on Windows 98 is not covered in this guide. This preface contains these topics: ■ Audience ■ Organization ■ Related Documentation ■ Conventions ■ Documentation Accessibility vii Audience This guide is intended for developers who create applications written in C that interact with one or more Oracle Servers. To use this document, you need to know: ■ How to compile and link a C program. ■ Your Microsoft Windows operating system. Organization This document contains: Chapter 1, "Introduction to Oracle Call Interface" Provides introductory information to help you get started with the OCI. Chapter 2, "Building OCI Applications" Provides an overview of how to build Oracle database applications using OCI. Related Documentation For more information, see these Oracle resources: ■ Oracle9i Database Installation Guide for Windows ■ Oracle9i Database Release Notes for Windows ■ Oracle9i Database Administrator’s Guide for Windows ■ Oracle Enterprise Manager Administrator’s Guide ■ Oracle9i Net Services Administrator’s Guide ■ Oracle9i Real Application Clusters Concepts ■ Oracle9i Database New Features ■ Oracle9i Database Concepts ■ Oracle9i Database Reference ■ Oracle9i Database Error Messages ■ Oracle Call Interface