20 OCIカートリッジ関数

この章では、カートリッジ関数について説明します。

関連項目: コード例は、Oracleのインストールに含まれているデモ・プログラムを参照してください。追加情報は、付録B「OCIデモ・プログラム」を参照してください。

この章は、次の項目で構成されています。

• 外部プロシージャ関数およびカートリッジ・サービス関数の概要

• カートリッジ・サービス: OCI外部プロシージャ

• カートリッジ・サービス: メモリー・サービス

• カートリッジ・サービス: コンテキストのメンテナンス

• カートリッジ・サービス: パラメータ・マネージャ・インタフェース

• カートリッジ・サービス: ファイルI/Oインタフェース

• カートリッジ・サービス: 文字列のフォーマット・インタフェース

外部プロシージャ関数およびカートリッジ・サービス関数の概要

この章では、最初にOCI外部プロシージャ関数について説明します。これらの関数により、外部プロシージャのユーザーは、エラーの通知、メモリーの割当ておよびOCIコンテキスト情報の取得ができます。

関連項目: これらの関数を外部プロシージャで使用する方法の詳細は、『Oracle Database Advanced Application Developer's Guide』の「外部プロシージャ」を参照してください。

次に、カートリッジ・サービスについて説明します。

関連項目: これらの関数の使用方法の詳細は、『Oracle Databaseデータ・カートリッジ開発者ガイド』を参照してください。

OCI関数の規則

各関数について、次の情報が記載されています。

用途

この関数によって実行されるアクションを簡単に説明します。

構文

関数の宣言。

パラメータ

この関数の各パラメータの説明。これにはパラメータのモードが含まれます。パラメータのモードには、次の3つの値があります。

表20-1 パラメータのモード

モード	説明
IN	OCIにデータを渡すパラメータ
OUT	このコールでOCIからデータを受け取るパラメータ
IN/OUT	このコールでデータを渡し、このコールまたは後続のコールからの戻りでデータを受け取るパラメータ

コメント

この関数に関する詳細情報。関数の使用上の制約やアプリケーション内でこの関数を使用するときに役に立つ情報が記載されています。

戻り値

この関数に対する戻り値のリスト。

関連関数

関連する関数コールのリスト。カートリッジ・サービスについては、ドキュメントに記載されている、グループ内の他のすべての関数を参照してください。

リターン・コード

成功とエラーのリターン・コードは、特定の外部プロシージャ・インタフェース関数に対して定義されます。 特定のインタフェース・ファンクションがOCIEXTPROC_SUCCESSまたはOCIEXTPROC_ERRORを戻した場合、アプリケーションはこれらのマクロを使用して戻り値をチェックする必要があります。

• OCIEXTPROC_SUCCESS− 外部プロシージャの成功した場合のリターン・コード

• OCIEXTPROC_ERROR− 外部プロシージャの失敗した場合のリターン・コード

With_Context型

PL/SQL外部プロシージャへのCコール可能インタフェースには、with_contextパラメータを渡す必要がありますこの構造体の型は、OCIExtProcContextで、ユーザーには不透明です。

ユーザーは、with_contextパラメータをアプリケーションで次のように宣言できます。

OCIExtProcContext *with_context;