28.5 OCIロー関数
OCIロー関数をリストし、説明します。
表28-14は、この項で説明しているOCIロー関数を示しています。
表28-14 ロー関数
関数 | 用途 |
---|---|
ロー・メモリーに割り当てられたサイズをバイト単位で取得します。 |
|
ローにロー・バイトを割り当てます。 |
|
ローにローを割り当てます。 |
|
ロー・データのポインタを取得します。 |
|
可変長ローのメモリー・サイズを変更します。 |
|
ローのサイズを取得します |
28.5.1 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)
-
戻されるロー・メモリーの割当てサイズ(バイト単位)。
コメント
割り当てられるサイズは、実際のロー・サイズより大きいかそれに等しくなります。
28.5.2 OCIRawAssignBytes()
ub1*
型のロー・バイトをOracleのOCIRaw*
データ型に割り当てます。
用途
ub1*
型のロー・バイトを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
になります。
28.5.3 OCIRawAssignRaw()
あるOracle RAW
データ型を別のOracle RAW
データ型に割り当てます。
用途
あるOracle RAW
データ型を別のOracle RAW
データ型に割り当てます。
構文
sword OCIRawAssignRaw ( OCIEnv *env, OCIError *err, const OCIRaw *rhs, OCIRaw **lhs );
パラメータ
コメント
rhs
OCIRaw
をlhs
OCIRaw
に割り当てます。lhs
OCIRaw
のサイズは、rhs
のサイズに応じて変更されます。
28.5.4 OCIRawPtr()
ロー・データへのポインタを取得します。
用途
ロー・データへのポインタを取得します。
構文
ub1 *OCIRawPtr ( OCIEnv *env, const OCIRaw *raw );
パラメータ
コメント
なし。
28.5.5 OCIRawResize()
指定の可変長raw
のメモリー・サイズを変更します。
用途
指定の可変長raw
のメモリー・サイズを変更します。
構文
sword OCIRawResize ( OCIEnv *env, OCIError *err, ub2 new_size, OCIRaw **raw );
パラメータ
コメント
この関数は、オブジェクト・キャッシュ内の指定した可変長rawのメモリーをサイズ変更します。rawの以前の内容は保存されません。また、指定したrawで占有されている元のメモリーが解放された場合に、新しいメモリー領域にrawを割り当てることがあります。入力raw値がNULL
の場合(raw
== NULL
)、この関数はrawデータにメモリーを割り当てます。
new_size
が0 (ゼロ)の場合、この関数はraw
が占有していたメモリーを解放し、NULL
ポインタ値を戻します。