19 OCIのデータ型マッピング関数および操作関数

この章では、OCIデータ型マッピング関数および操作関数について説明します。

これらの関数は、Oracle Database事前定義型に対する、Oracleの外部C言語インタフェースです。

関連項目:

コード例は、Oracle Databaseのインストールに含まれているデモ・プログラムを参照してください。詳細は、「OCIデモ・プログラム」を参照してください。

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

• データ型マッピング関数および操作関数の概要

• OCIコレクションおよびイテレータ関数

• OCIの日付関数、日時関数および時間隔関数

• OCI NUMBER関数

• OCIロー関数

• OCI REF関数

• OCI文字列関数

• OCI表関数

データ型マッピング関数および操作関数の概要

OCIデータ型マッピング関数および操作関数の詳細について説明します。

この項では、OCIデータ型マッピング関数および操作関数の詳細を説明します。

関連項目:

この章にリストされている関数の詳細は、「OCIのオブジェクト・リレーショナル・データ型」を参照してください

OCI関数の規則

OCI関数の記述に使用される規則を示します。

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

戻り値

表19-1にリストされている標準リターン・コード以外の値が関数によって戻される場合の、戻り値の説明です。

データ型マッピング関数および操作関数の戻り値

関数の戻り値について説明します。

OCIのデータ型マッピング関数および操作関数は、通常、表19-1に示す値のいずれかを戻します。

表19-1 関数戻り値

戻り値	意味
OCI_SUCCESS	操作は成功しました。
OCI_ERROR	操作は失敗しました。関数に渡されたエラー・ハンドルに対してOCIErrorGet()をコールすることで特定のエラーを取り出せます。
OCI_INVALID_HANDLE	関数に渡されたOCIハンドルが無効です。

関連項目:

リターン・コードおよびエラー処理の詳細は、「OCIでのエラー処理」を参照してください

その他の値を戻す関数

一部の関数は、表19-1にリストされていない値を戻します。これらの関数を使用する場合、OUTパラメータからではなく、関数コールから直接値が戻ります。

• OCICollMax()

• OCIRawPtr()

• OCIRawSize()

• OCIRefHexSize()

• OCIRefIsEqual()

• OCIRefIsNull()

• OCIStringPtr()

• OCIStringSize()

データ型マッピング関数および操作関数のサーバー・ラウンドトリップ回数

個々のOCIデータ型マッピング関数および操作関数に必要なサーバー・ラウンドトリップ回数を示す表は、表C-5を参照してください。

例

コード例など、これらの関数の詳細は、「OCIのオブジェクト・リレーショナル・データ型」を参照してください。