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

この章では、OCIのデータ型マッピング関数および操作関数について説明します。これらはOracle事前定義型に対する、Oracleの外部C言語インタフェースです。

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

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

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

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

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

• OCI NUMBER関数

• OCIロー関数

• OCI REF関数

• OCI文字列関数

• OCI表関数

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

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

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

OCI関数の規則

関数ごとに次の情報が記載されています。

用途

関数の用途を簡単に説明します。

構文

関数の宣言。

コメント

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

パラメータ

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

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

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

戻り値

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

関連関数

関連する関数のリスト

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

OCIのデータ型マッピング関数および操作関数は、通常、次の値の1つを戻します。

表19-2 関数戻り値

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

この章では、各関数に関する記述の後で関数固有の戻り値に関する情報を説明します。

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

その他の値を戻す関数

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

• OCICollMax()

• OCIRawPtr()

• OCIRawSize()

• OCIRefHexSize()

• OCIRefIsEqual()

• OCIRefIsNull()

• OCIStringPtr()

• OCIStringSize()

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

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

例

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