16 OCIリレーショナル関数

この章では、最初にC言語対応のOracle OCIリレーショナル関数について説明します。各ファンクション・コールについて詳細に説明するとともに、使用しているアプリケーションでOCI関数をコールする方法についても解説します。

リレーショナル関数の概要

この章では、OCIリレーショナル・ファンクション・コールについて説明します。この章と次の章で説明する関数は、基本OCIにおける関数です。

OCI関数の規則

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

用途

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

構文

関数の宣言。

パラメータ

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

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

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

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

戻り値

このオプションの項では、戻される可能性のある値について説明します。この項は、「コメント」の項の前または後にあります。

例

説明の対象となっているファンクション・コールの使用方法を例示するコード（全体または一部）。すべての関数に例が記載されているわけではありません。

OCI関数のコール

OCIのこれまでのバージョンとは異なり、リリース8以上のOCIでは、NULL文字で終了する文字列の文字列長パラメータに-1を渡すことはできません。文字列長をパラメータとして渡すときは、NULL終了文字バイトを組み込まないでください。OCIでは、文字列はNULLで終了するとはみなされません。

OCIパラメータのバッファ長は、バイト単位です。ただし、次の場合は除きます。

いくつかのLOBコール内のamountパラメータが文字単位である場合。
関数パラメータにUTF-16エンコーディングのテキストが使用されており、その長さが文字のポイント単位である場合。

LOB関数用のサーバー・ラウンドトリップ

個々のOCI LOB関数に必要なサーバー・ラウンドトリップ回数については、付録C「OCI関数のサーバー・ラウンドトリップ」の表を参照してください。