20 OCIカートリッジ関数

この章では、カートリッジ関数について説明します。コード例は、Oracle Databaseのインストールに含まれているデモ・プログラムを参照してください。詳細は、付録Bを参照してください。

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

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

この章では、最初にOCI外部プロシージャ関数について説明します。これらの関数により、外部プロシージャのユーザーは、エラーの通知、メモリーの割当ておよびOCIコンテキスト情報の取得ができます。これらの関数を外部プロシージャで使用する方法の詳細は、『Oracle Databaseアドバンスト・アプリケーション開発者ガイド』を参照してください。

次に、カートリッジ・サービスについて説明します。これらの関数の使用方法の詳細は、『Oracle Databaseデータ・カートリッジ開発者ガイド』を参照してください。

OCI関数の規則

各関数を記述する際に使用される規則は、「OCI関数の規則」を参照してください。関数ごとに次の情報が記載されている場合もあります。

リターン・コード

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

OCIEXTPROC_SUCCESS－外部プロシージャの成功した場合のリターン・コード
OCIEXTPROC_ERROR－外部プロシージャの失敗した場合のリターン・コード

With_Context型

C言語におけるPL/SQL外部プロシージャへのコール可能なインタフェースでは、with_contextパラメータを渡す必要があります。この構造体の型はOCIExtProcContextで、ユーザーには認識されません。

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

OCIExtProcContext *with_context;