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

OCIリレーショナル関数コールの概要を説明します。

この章および「他のOracle Database Access C API」では、OCIリレーショナル関数コールと、基本OCIにおける関数について説明します。

• OCI関数の規則
  OCI関数に使用される規則について説明します。
• 目的
  関数の用途を示します。
• 構文
  
• パラメータ
  この関数の各パラメータとそのモードの説明です。
• コメント
  この関数に関する詳細情報(ある場合)を示します。
• 戻り値
  このオプションの項では、戻される可能性のある値について説明します。
• 例
  説明の対象となっている関数コールの使用方法を例示するコード(全体または一部)を示します。
• 関連関数
  関数に関連する関数コールのリストを示します(該当する場合)。
• OCI関数のコールについて
  OCI関数のコールに関する有用な情報を提供します。
• LOB関数用のサーバー・ラウンドトリップ
  個々のOCI LOB関数に必要なサーバー・ラウンドトリップ回数を示します。

関連項目:

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

OCI関数の規則

OCI関数に使用される規則について説明します。

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

用途

関数の用途を示します。

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

構文

関数の宣言方法を示します。

関数の宣言です。

パラメータ

この関数の各パラメータとそのモードの説明です。

この説明にはパラメータのモードが含まれます。パラメータのモードには、表25-1に示す3つの値があります。

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

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

コメント

この関数に関する詳細情報(ある場合)を示します。

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

戻り値

このオプションの項では、戻される可能性のある値について説明します。

この項は、「コメント」の項の前または後にあります。

例

説明の対象となっている関数コールの使用方法を例示するコード(全体または一部)を示します。

すべての関数に例が記載されているわけではありません。

関連関数

関数に関連する関数コールのリストを示します(該当する場合)。

関連する関数コールのリスト。

OCI関数のコールについて

OCI関数のコールに関する有用な情報を提供します。

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

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

• いくつかのLOBコール内のamountパラメータが文字単位である場合。

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

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

個々のOCI LOB関数に必要なサーバー・ラウンドトリップ回数を示します。

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