Skip Headers

Oracle Call Interface Programmer's Guide
Release 2 (9.2)

Part Number A96584-01
Go To Documentation Library
Home
Go To Product List
Book List
Go To Table Of Contents
Contents
Go To Index
Index

Master Index

Feedback

Go to previous page Go to next page

19
OCI Cartridge Functions

This chapter presents the cartridge functions.

See Also:

For code examples, see the demonstration programs included with your Oracle installation. For additional information, refer to Appendix B, "OCI Demonstration Programs".

The chapter contains the following sections:

Introduction to External Procedure and Cartridge Services Functions

This chapter first describes the OCI external procedure functions. These functions enable users of external procedures to raise errors, allocate some memory, and get OCI context information.

See Also:

For more information about using these functions in external procedures, see the chapter on external routines in Oracle9i Application Developer's Guide - Fundamentals

Then the cartridge services functions are described.

See Also:

For more information about using these functions, see Oracle9i Data Cartridge Developer's Guide

The Function Syntax

For each function, the following information is listed:

Purpose

A brief description of the action performed by the function.

Syntax

The function declaration.

Parameters

A description of each of the function's parameters. This includes the parameter's mode. The mode of a parameter has three possible values, as described below:

Mode Description

IN

A parameter that passes data to Oracle

OUT

A parameter that receives data from Oracle on this or a subsequent call

IN/OUT

A parameter that passes data on the call and receives data on the return from this or a subsequent call.

Comments

More detailed information about the function (if available). This may include restrictions on the use of the function, or other information that might be useful when using the function in an application.

Returns

A list of possible return values for the function.

Related Functions

A list of related function calls. For cartridge services, see all the other functions in the group being documented.

Return Codes

Success and error return codes are defined for certain external procedure interface functions. If a particular interface function returns OCIEXTPROC_SUCCESS or OCIEXTPROC_ERROR, then applications must use these macros to check for return values.

With_Context Type

The C callable interface to PL/SQL external procedures requires the with_context parameter to be passed. The type of this structure is OCIExtProcContext, which is opaque to the user.

The user can declare the with_context parameter in the application as

OCIExtProcContext *with_context;

Cartridge Services -- OCI External Procedures

The OCI external procedure functions for C:

Table 19-1 External Procedures Functions
Function/Page Purpose

OCIExtProcAllocCallMemory()

Allocates memory for the duration of the External Procedure

OCIExtProcRaiseExcp()

Raises an Exception to PL/SQL

OCIExtProcRaiseExcpWithMsg()

Raises an exception with a message

OCIExtProcGetEnv()

Gets the OCI environment, service context, and error handles


Go to previous page Go to next page
Oracle
Copyright © 1996, 2002 Oracle Corporation.

All Rights Reserved.
Go To Documentation Library
Home
Go To Product List
Book List
Go To Table Of Contents
Contents
Go To Index
Index

Master Index

Feedback