OCIロー関数

この項では、OCIロー関数について説明します。

表19-15 ロー関数

関数	用途
OCIRawAllocSize()	ロー・メモリーに割り当てられたサイズをバイト単位で取得します。
OCIRawAssignBytes()	ローにロー・バイトを割り当てます。
OCIRawAssignRaw()	ローにローを割り当てます。
OCIRawPtr()	ロー・データのポインタを取得します。
OCIRawResize()	可変長ローのメモリー・サイズを変更します。
OCIRawSize()	ローのサイズを取得します。

OCIRawAllocSize()

用途

ロー・メモリーの割当てサイズをバイト単位で取得します。

構文

sword OCIRawAllocSize ( OCIEnv             *env,
                        OCIError           *err,
                        const OCIRaw       *raw,
                        ub4                *allocsize );

パラメータ

env (IN/OUT)

オブジェクト・モードで初期化されたOCI環境ハンドルです。

関連項目:

「OCIEnvCreate()」および「OCIInitialize()」

err (IN/OUT)

OCIエラー・ハンドルです。エラーがある場合は、errに記録され、OCI_ERRORが戻されます。OCIErrorGet()をコールして診断情報を取得します。

raw (IN)

割り当てられたサイズがバイト単位で戻されるロー・データです。これは、NULL以外のポインタにしてください。

allocsize (OUT)

ロー・メモリーの割当てサイズをバイト単位で戻します。

割り当てられるサイズは、実際のロー・サイズより大きいかそれに等しくなります。

OCIRawAssignBytes()

用途

ub1*型のロー・バイトをOracleのOCIRaw*データ型に割り当てます。

構文

sword OCIRawAssignBytes ( OCIEnv             *env,
                          OCIError           *err,
                          const ub1          *rhs,
                          ub4                rhs_len,
                          OCIRaw             **lhs );

パラメータ

env (IN/OUT)

オブジェクト・モードで初期化されたOCI環境ハンドルです。

関連項目:

「OCIEnvCreate()」および「OCIInitialize()」

err (IN/OUT)

OCIエラー・ハンドルです。エラーがある場合は、errに記録され、OCI_ERRORが戻されます。OCIErrorGet()をコールして診断情報を取得します。

rhs (IN)

割当ての右側（ソース）となるub1データ型です。

rhs_len (IN)

rhsロー・バイトの長さです。

lhs (IN/OUT)

割当ての左側（ターゲット）となるOCIRawデータです。

rhsロー・バイトをlhsロー・データ型に割り当てます。lhsローのサイズは、rhsのサイズに応じて変更されます。割り当てられたロー・バイトの型はub1になります。

関連関数

OCIErrorGet()、OCIRawAssignRaw()

OCIRawAssignRaw()

用途

あるOracle RAWデータ型を別のOracle RAWデータ型に割り当てます。

構文

sword OCIRawAssignRaw ( OCIEnv             *env,
                        OCIError           *err,
                        const OCIRaw       *rhs,
                        OCIRaw             **lhs );

パラメータ

env (IN/OUT)

オブジェクト・モードで初期化されたOCI環境ハンドルです。

関連項目:

「OCIEnvCreate()」および「OCIInitialize()」

err (IN/OUT)

OCIエラー・ハンドルです。エラーがある場合は、errに記録され、OCI_ERRORが戻されます。OCIErrorGet()をコールして診断情報を取得します。

rhs (IN)

割当ての右側（ソース）となるOCIRawデータです。

lhs (IN/OUT)

割当ての左側（ターゲット）となるOCIRawデータです。

rhsローをlhsローに割り当てます。lhsローのサイズは、rhsのサイズに応じて変更されます。

関連関数

OCIErrorGet()、OCIRawAssignBytes()

OCIRawPtr()

用途

ロー・データへのポインタを取得します。

構文

ub1 *OCIRawPtr ( OCIEnv             *env,
                 const OCIRaw       *raw );

パラメータ

env (IN/OUT)

オブジェクト・モードで初期化されたOCI環境ハンドルです。

関連項目:

「OCIEnvCreate()」および「OCIInitialize()」

raw (IN)

指定されたロー・データのポインタを戻します。

なし

関連関数

OCIErrorGet()、OCIRawAssignRaw()

OCIRawResize()

用途

指定の可変長ローのメモリー・サイズを変更します。

構文

sword OCIRawResize ( OCIEnv          *env,
                     OCIError        *err,
                     ub2             new_size,
                     OCIRaw          **raw );

パラメータ

env (IN/OUT)

オブジェクト・モードで初期化されたOCI環境ハンドルです。

関連項目:

「OCIEnvCreate()」および「OCIInitialize()」

err (IN/OUT)

OCIエラー・ハンドルです。エラーがある場合は、errに記録され、OCI_ERRORが戻されます。OCIErrorGet()をコールして診断情報を取得します。

new_size (IN)

バイト単位での新規ロー・データのサイズです。

raw (IN)

可変長ロー・ポインタです。ローのサイズはnew_sizeに変更されます。

この関数は、オブジェクト・キャッシュ内の指定の可変長ローのメモリー・サイズを変更します。そのローの以前の内容は保持されません。この関数は、新しいメモリー・リージョンにローを割り当てる場合があります。その場合、指定のローが占有していたメモリーは解放されます。入力ローがNULL（raw == NULL）の場合、この関数は、ロー・データ用のメモリーを割り当てます。

new_sizeが0（ゼロ）の場合、この関数はrawが占有していたメモリーを解放し、NULLポインタ値を戻します。

OCIRawSize()

用途

指定のローのサイズをバイト単位で戻します。

構文

ub4 OCIRawSize ( OCIEnv             *env,
                 const OCIRaw       *raw );

パラメータ

env (IN/OUT)

オブジェクト・モードで初期化されたOCI環境ハンドルです。

関連項目:

「OCIEnvCreate()」および「OCIInitialize()」

raw (IN/OUT)

サイズが戻されるローです。

なし