29.1 外部プロシージャ関数およびカートリッジ・サービス関数の概要
この項では、OCI外部プロシージャ関数の概要を説明します。
これらの関数により、外部プロシージャのユーザーは、エラーの通知、メモリーの割当ておよびOCIコンテキスト情報の取得ができます。
関連項目:
-
外部プロシージャでこれらの関数を使用する方法の詳細は、『Oracle Database開発ガイド』を参照してください
-
これらの関数の使用方法の詳細は、『Oracle Databaseデータ・カートリッジ開発者ガイド』を参照してください
29.1.1 OCI関数の規則
各関数を記述する際に使用される規則について説明します。
-
リターン・コード
-
With_Context型
リターン・コード
成功とエラーのリターン・コードは、特定の外部プロシージャ・インタフェース関数に対して定義されます。特定のインタフェース・ファンクションがOCIEXTPROC_SUCCESS
またはOCIEXTPROC_ERROR
を戻した場合、アプリケーションはこれらのマクロを使用して戻り値をチェックする必要があります。
-
OCIEXTPROC_SUCCESS
- 外部プロシージャの成功した場合のリターン・コード -
OCIEXTPROC_ERROR
- 外部プロシージャの失敗した場合のリターン・コード
With_Context型
CにおけるPL/SQL外部プロシージャへのコール可能なインタフェースでは、with_context
パラメータを渡す必要があります。この構造体の型はOCIExtProcContext
で、ユーザーには認識されません。
ユーザーは、with_context
パラメータをアプリケーションで次のように宣言できます。
OCIExtProcContext *with_context;