OCIロー関数

表19-14は、この項で説明しているOCIロー関数を示しています。

表19-14 ロー関数

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

OCIRawAllocSize()

用途

ロー・メモリーの割り当てられたサイズ(バイト単位)を取得します。

構文

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

パラメータ

env (IN/OUT)

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

関連項目:

「OCIEnvCreate()」、「OCIEnvNlsCreate()」および「OCIInitialize()」(非推奨)

err (IN/OUT)

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

raw (IN)

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

allocsize (OUT)

戻されるロー・メモリーの割当てサイズ(バイト単位)。

コメント

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

関連関数

OCIErrorGet()、OCIRawResize()、OCIRawSize()

OCIRawAssignBytes()

用途

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

構文

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

パラメータ

env (IN/OUT)

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

関連項目:

「OCIEnvCreate()」、「OCIEnvNlsCreate()」および「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()」、「OCIEnvNlsCreate()」および「OCIInitialize()」(非推奨)

err (IN/OUT)

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

rhs (IN)

割当ての右側(rhs) (ソース)となるOCIRawデータです。

lhs (IN/OUT)

割当ての左側(lhs) (ターゲット)となるOCIRawデータです。

コメント

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

関連関数

OCIErrorGet()、OCIRawAssignBytes()

OCIRawPtr()

用途

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

構文

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

パラメータ

env (IN/OUT)

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

関連項目:

「OCIEnvCreate()」、「OCIEnvNlsCreate()」および「OCIInitialize()」(非推奨)

raw (IN)

指定されたrawのデータへのポインタ。

コメント

なし。

関連関数

OCIErrorGet()、OCIRawAssignRaw()

OCIRawResize()

用途

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

構文

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

パラメータ

env (IN/OUT)

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

関連項目:

「OCIEnvCreate()」、「OCIEnvNlsCreate()」および「OCIInitialize()」(非推奨)

err (IN/OUT)

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

new_size (IN)

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

raw (IN)

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

コメント

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

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

関連関数

OCIErrorGet()、OCIRawAllocSize()、OCIRawSize()

OCIRawSize()

用途

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

構文

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

パラメータ

env (IN/OUT)

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

関連項目:

「OCIEnvCreate()」、「OCIEnvNlsCreate()」および「OCIInitialize()」(非推奨)

raw (IN/OUT)

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

コメント

なし。

関連関数

OCIErrorGet()、OCIRawAllocSize()、OCIRawResize()