28.4 OCI_NUMBER関数
OCI NUMBER
関数をリストし、説明します。
表28-11は、この項で説明しているOCI NUMBER
関数を示しています。
関連項目:
表28-11 NUMBER関数
関数 | 用途 |
---|---|
絶対値を計算します。 |
|
|
|
アーク・コサインを計算します。 |
|
アーク・サインを計算します。 |
|
アーク・タンジェントを計算します。 |
|
|
|
1つの |
|
|
|
1つの |
|
コサインを計算します |
|
|
|
|
|
eを指定のOracle |
|
|
|
整数をOracle |
|
実数型をOracle |
|
文字列をOracle |
|
双曲線コサインを計算します。 |
|
双曲線サインを計算します。 |
|
双曲線タンジェントを計算します。 |
|
Oracle |
|
指定の基数を整数で累乗します。 |
|
|
|
|
|
自然対数を計算します。 |
|
任意の基数に対する対数を計算します。 |
|
2つのOracle |
|
1つのOracle |
|
Oracle |
|
指定の基数を指定の指数で累乗します。 |
|
|
|
Oracle |
|
|
|
|
|
10の累乗を乗算し、小数点以下を指定の桁数にします。 |
|
Oracle |
|
サインを計算します |
|
|
|
|
|
タンジェントを計算します |
|
Oracle |
|
Oracle |
|
|
|
Oracle |
|
Oracle |
28.4.1 OCINumberAbs()
Oracle NUMBER
の絶対値を計算します。
用途
Oracle NUMBER
の絶対値を計算します。
構文
sword OCINumberAbs ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.2 OCINumberAdd()
NUMBER
を別のNUMBER
に加算します。
用途
NUMBER
を別のNUMBER
に加算します。
構文
sword OCINumberAdd ( OCIError *err, const OCINumber *number1, const OCINumber *number2, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.3 OCINumberArcCos()
Oracle NUMBER
のアーク・コサインをラジアン単位で求めます。
用途
Oracle NUMBER
のアーク・コサインをラジアン単位で求めます。
構文
sword OCINumberArcCos ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
NUMBER
引数がNULL
である場合、number
が-1より小さい場合、またはnumber
が1より大きい場合には、この関数はエラーを戻します。
関連トピック
28.4.4 OCINumberArcSin()
Oracle NUMBER
のアーク・サインをラジアン単位で求めます。
用途
Oracle NUMBER
のアーク・サインをラジアン単位で求めます。
構文
sword OCINumberArcSin ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
NUMBER
引数がNULL
である場合、number
が-1より小さい場合、またはnumber
が1より大きい場合には、この関数はエラーを戻します。
関連トピック
28.4.5 OCINumberArcTan()
Oracle NUMBER
のアーク・タンジェントをラジアン単位で求めます。
用途
Oracle NUMBER
のアーク・タンジェントをラジアン単位で求めます。
構文
sword OCINumberArcTan ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.6 OCINumberArcTan2()
Oracle NUMBER
の指定した2つの引数のアーク・タンジェントを取得します。
用途
Oracle NUMBER
の指定した2つの引数のアーク・タンジェントを取得します。
構文
sword OCINumberArcTan2 ( OCIError *err, const OCINumber *number1, const OCINumber *number2, OCINumber *result );
パラメータ
戻り値
この関数は、NULL
のNUMBER
引数がある場合、またはnumber2
が0 (ゼロ)の場合はエラーを戻します。
関連トピック
28.4.7 OCINumberAssign()
1つのOracle NUMBER
を別のOracle NUMBER
に代入します。
用途
1つのOracle NUMBER
を別のOracle NUMBER
に代入します。
構文
sword OCINumberAssign ( OCIError *err, const OCINumber *from, OCINumber *to );
パラメータ
コメント
from
によって識別されたNUMBER
をto
によって識別されたNUMBER
に代入します。
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.8 OCINumberCeil()
Oracle NUMBER
の上限値を計算します。
用途
Oracle NUMBER
の上限値を計算します。
構文
sword OCINumberCeil ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.9 OCINumberCmp()
1つのOracle NUMBER
を別のOracle NUMBER
と比較します。
用途
1つのOracle NUMBER
を別のOracle NUMBER
と比較します。
構文
sword OCINumberCmp ( OCIError *err, const OCINumber *number1, const OCINumber *number2, sword *result );
パラメータ
- err (IN/OUT)
-
OCIエラー・ハンドルです。エラーがある場合は、
err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()
をコールして診断情報を取得します。 - number1、number2 (IN)
-
1番目の
NUMBER
が2番目のNUMBER
と比較されます。 - result (OUT)
-
表28-12に指定したような比較結果です。
表28-12 OCINumberCmp()のresultパラメータによって戻される比較結果
比較結果 | resultパラメータの出力 |
---|---|
|
負数 |
|
|
|
正数 |
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.10 OCINumberCos()
Oracle NUMBER
のコサインをラジアン単位で計算します。
用途
Oracle NUMBER
のコサインをラジアン単位で計算します。
構文
sword OCINumberCos ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.11 OCINumberDec()
12.1.0.2、簡単な説明を追加しました。
用途
Oracle NUMBER
を適切に減分します。
構文
sword OCINumberDec ( OCIError *err, OCINumber *number );
パラメータ
コメント
Oracle NUMBER
を適切に減分します。入力値は0から100^21-2の整数であるとみなされます。入力値が大きすぎる場合は0 (ゼロ)として扱われ、その結果、Oracle NUMBER
は1になります。入力値が正の整数でない場合は、予想できない結果になります。
戻り値
この関数は、入力NUMBER
にNULL
がある場合はエラーを戻します。
関連トピック
28.4.12 OCINumberDiv()
1つのOracle NUMBER
を別のOracle NUMBER
で除算します。
用途
1つのOracle NUMBER
を別のOracle NUMBER
で除算します。
構文
sword OCINumberDiv ( OCIError *err, const OCINumber *number1, const OCINumber *number2, OCINumber *result );
パラメータ
コメント
number1
をnumber2
で除算し、その結果をresult
に戻します。
戻り値
この関数は、次のいずれかの文がTRUEである場合はエラーを戻します。
-
NUMBER
引数にNULL
がある場合。 -
アンダーフロー・エラーがある場合。
-
ゼロによる除算エラーがある場合。
関連トピック
28.4.13 OCINumberExp()
eを指定のOracle NUMBER
で累乗します。
用途
eを指定のOracle NUMBER
で累乗します。
構文
sword OCINumberExp ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.14 OCINumberFloor()
Oracle NUMBER
の下限(切捨て)値を計算します。
用途
Oracle NUMBER
の下限(切捨て)値を計算します。
構文
sword OCINumberFloor ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.15 OCINumberFromInt()
整数をOracle NUMBER
に変換します。
用途
整数をOracle NUMBER
に変換します。
構文
sword OCINumberFromInt ( OCIError *err, const void *inum, uword inum_length, uword inum_s_flag, OCINumber *number );
パラメータ
- err (IN/OUT)
-
OCIエラー・ハンドルです。エラーがある場合は、
err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()
をコールして診断情報を取得します。 - inum (IN)
-
変換する整数へのポインタです。
- inum_length (IN)
-
整数のサイズです。
- inum_s_flag (IN)
-
整数の符号を指定するフラグで、可能な値は次のとおりです。
-
OCI_NUMBER_UNSIGNED
- 符号なしの値 -
OCI_NUMBER
_SIGNED
- 符号付きの値
コメント
これは、システム固有な型変換関数です。ub4
やsb2
などのOracle標準システム固有の整数型をOracle NUMBER
に変換します。
戻り値
この関数は、数値が大きすぎてOracle NUMBER
に適合しない場合、number
またはinum
がNULL
の場合、あるいはinum_s_flag
に無効な符号フラグの値が渡された場合は、エラーを戻します。
関連トピック
28.4.16 OCINumberFromReal()
実数(浮動小数点数)型をOracle NUMBER
に変換します。
用途
実数(浮動小数点数)型をOracle NUMBER
に変換します。
構文
sword OCINumberFromReal ( OCIError *err, const void *rnum, uword rnum_length, OCINumber *number );
パラメータ
コメント
これは、システム固有な型変換関数です。システム固有の浮動小数点型をOracle NUMBER
に変換します。
戻り値
この関数は、number
またはrnum
がNULL
であるか、rnum_length
が0 (ゼロ)である場合はエラーを戻します。
関連トピック
28.4.17 OCINumberFromText()
文字列をOracle NUMBER
に変換します。
用途
文字列をOracle NUMBER
に変換します。
構文
sword OCINumberFromText ( OCIError *err, const OraText *str, ub4 str_length, const OraText *fmt, ub4 fmt_length, const OraText *nls_params, ub4 nls_p_length, OCINumber *number );
パラメータ
- err (IN/OUT)
-
OCIエラー・ハンドルです。エラーがある場合は、
err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()
をコールして診断情報を取得します。 - str (IN)
-
Oracle
NUMBER
に変換する入力文字列です。 - str_length (IN)
-
入力文字列のサイズです。
- fmt (IN)
-
変換書式です。
- fmt_length (IN)
-
fmt
パラメータの長さです。 - nls_params (IN)
-
グローバリゼーション・サポートのフォーマット指定です。
NULL
文字列("")の場合は、セッションのデフォルト・パラメータが使用されます。 - nls_p_length (IN)
-
nls_params
パラメータの長さです。 - number (OUT)
-
NUMBER
に変換される指定の文字列です。
コメント
指定された文字列を指定の書式のNUMBER
に変換します。書式および多言語パラメータの詳細は、『Oracle Database SQL言語リファレンス』のTO_NUMBER
変換関数の説明を参照してください。
戻り値
この関数は、無効な書式、マルチバイト書式または入力文字列がある場合、number
またはstr
がNULL
である場合、あるいはstr_length
が0 (ゼロ)である場合はエラーを戻します。
28.4.18 OCINumberHypCos()
Oracle NUMBER
の双曲線コサインを計算します。
用途
Oracle NUMBER
の双曲線コサインを計算します。
構文
sword OCINumberHypCos ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、number
引数のいずれかにNULL
がある場合はエラーを戻します。
ノート:
Oracle NUMBER
のオーバーフローは、予想できない結果値が出力される原因となります。
28.4.19 OCINumberHypSin()
Oracle NUMBER
の双曲線サインを計算します。
用途
Oracle NUMBER
の双曲線サインを計算します。
構文
sword OCINumberHypSin ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数のいずれかにNULL
がある場合はエラーを戻します。
ノート:
Oracle NUMBER
のオーバーフローは、予想できない結果値が出力される原因となります。
28.4.20 OCINumberHypTan()
Oracle NUMBER
の双曲線タンジェントを計算します。
用途
Oracle NUMBER
の双曲線タンジェントを計算します。
構文
sword OCINumberHypTan ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数のいずれかにNULL
がある場合はエラーを戻します。
ノート:
Oracle NUMBER
のオーバーフローは、予想できない結果値が出力される原因となります。
28.4.21 OCINumberInc()
Oracle NUMBER
を増分します。
用途
Oracle NUMBER
を増分します。
構文
sword OCINumberInc ( OCIError *err, OCINumber *number );
パラメータ
コメント
Oracle NUMBER
を適切に増分します。入力値は0から100^21-2の整数であるとみなされます。入力値が大きすぎる場合は0 (ゼロ)として扱われ、その結果、Oracle NUMBER
は1になります。入力値が正の整数でない場合は、予想できない結果になります。
戻り値
この関数は、入力NUMBER
にNULL
がある場合はエラーを戻します。
関連トピック
28.4.22 OCINumberIntPower()
指定の基数を指定の整数で累乗します。
用途
指定の基数を指定の整数で累乗します。
構文
sword OCINumberIntPower ( OCIError *err, const OCINumber *base, const sword exp, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数のいずれかにNULL
がある場合はエラーを戻します。
関連トピック
28.4.23 OCINumberIsInt()
OCINumberが整数かどうかをテストします。
用途
OCINumberが整数かどうかをテストします。
構文
sword OCINumberIsInt ( OCIError *err, const OCINumber *number, boolean *result );
パラメータ
戻り値
この関数は、number
またはresult
がNULL
の場合にエラーを戻します。
28.4.24 OCINumberIsZero()
指定のNUMBER
が0 (ゼロ)に等しいかどうかをテストします。
用途
指定のNUMBER
が0 (ゼロ)に等しいかどうかをテストします。
構文
sword OCINumberIsZero ( OCIError *err, const OCINumber *number, boolean *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.25 OCINumberLn()
Oracle NUMBER
の自然対数(基数e)を求めます。
用途
Oracle NUMBER
の自然対数(基数e)を求めます。
構文
sword OCINumberLn ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数がNULL
のいずれかである場合、またはnumber
が0 (ゼロ)以下の場合はエラーを戻します。
28.4.26 OCINumberLog()
Oracle NUMBER
の任意の基数に対する対数を求めます。
用途
Oracle NUMBER
の任意の基数に対する対数を求めます。
構文
sword OCINumberLog ( OCIError *err, const OCINumber *base, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、次の場合にエラーを戻します。
-
NUMBER
引数にNULL
がある場合 -
number
の値 <= 0の場合 -
base
の値 <= 0の場合
関連トピック
28.4.27 OCINumberMod()
2つのOracle NUMBER
の除算の余り(剰余)を取得します。
用途
2つのOracle NUMBER
の除算の余り(剰余)を取得します。
構文
sword OCINumberMod ( OCIError *err, const OCINumber *number1, const OCINumber *number2, OCINumber *result );
パラメータ
戻り値
この関数は、number1
またはnumber2
がNULL
か、0 (ゼロ)による除算エラーがある場合にエラーを戻します。
関連トピック
28.4.28 OCINumberMul()
1つのOracle NUMBER
に別のOracle NUMBER
を乗算します。
用途
1つのOracle NUMBER
に別のOracle NUMBER
を乗算します。
構文
sword OCINumberMul ( OCIError *err, const OCINumber *number1, const OCINumber *number2, OCINumber *result );
パラメータ
コメント
number1
にnumber2
を乗算し、その結果をresult
に戻します。
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.29 OCINumberNeg()
Oracle NUMBER
を負の数にします。
用途
Oracle NUMBER
を負の数にします。
構文
sword OCINumberNeg ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数のいずれかにNULL
がある場合はエラーを戻します。
28.4.30 OCINumberPower()
指定の基数を指定の指数で累乗します。
用途
指定の基数を指定の指数で累乗します。
構文
sword OCINumberPower ( OCIError *err, const OCINumber *base, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.31 OCINumberPrec()
OCINumber
を指定の小数点以下の桁数に丸めます。
用途
OCINumber
を指定の小数点以下の桁数に丸めます。
構文
sword OCINumberPrec ( OCIError *err, const OCINumber *number, eword nDigs, OCINumber *result );
パラメータ
コメント
桁数に基づいて、浮動小数点を丸めます。
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.32 OCINumberRound()
Oracle NUMBER
を指定の小数点以下の桁数に丸めます。
用途
Oracle NUMBER
を指定の小数点以下の桁数に丸めます。
構文
sword OCINumberRound ( OCIError *err, const OCINumber *number, sword decplace, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.33 OCINumberSetPi()
OCINumber
をpiに設定します。
用途
OCINumber
をpiに設定します。
構文
void OCINumberSetPi ( OCIError *err, OCINumber *num );
パラメータ
コメント
指定のNUMBER
をpiの値に初期化します。
関連トピック
28.4.34 OCINumberSetZero()
Oracle NUMBER
を0 (ゼロ)に初期化します。
用途
Oracle NUMBER
を0 (ゼロ)に初期化します。
構文
void OCINumberSetZero ( OCIError *err OCINumber *num );
パラメータ
コメント
なし。
関連トピック
28.4.35 OCINumberShift()
NUMBER
を10の累乗で乗算し、小数点を指定の桁に移動します。
用途
NUMBER
を10の累乗で乗算し、小数点を指定の桁に移動します。
構文
sword OCINumberShift ( OCIError *err, const OCINumber *number, const sword nDig, OCINumber *result );
パラメータ
コメント
number
を10^nDig
で乗算し、product
に結果を設定します。
戻り値
この関数は、入力number
にNULL
がある場合はエラーを戻します。
関連トピック
28.4.36 OCINumberSign()
Oracle NUMBER
の符号を取得します。
用途
Oracle NUMBER
の符号を取得します。
構文
sword OCINumberSign ( OCIError *err, const OCINumber *number, sword *result );
パラメータ
- err (IN/OUT)
-
OCIエラー・ハンドルです。エラーがある場合は、
err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()
をコールして診断情報を取得します。 - number (IN)
-
符号が戻されるOracle
NUMBER
です。 - result (OUT)
-
表28-13は、可能な戻り値を示しています。
表28-13 結果の値
numberの値 | resultパラメータの出力 |
---|---|
|
-1 |
|
0 |
|
1 |
戻り値
この関数は、number
またはresult
がNULL
の場合にエラーを戻します。
関連トピック
28.4.37 OCINumberSin()
Oracle NUMBER
のサインをラジアン単位で計算します。
用途
Oracle NUMBER
のサインをラジアン単位で計算します。
構文
sword OCINumberSin ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、number
引数のいずれかにNULL
がある場合はエラーを戻します。
関連トピック
28.4.38 OCINumberSqrt()
Oracle NUMBER
の平方根を計算します。
用途
Oracle NUMBER
の平方根を計算します。
構文
sword OCINumberSqrt ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、number
がNULL
または負のnumber
の場合はエラーを戻します。
関連トピック
28.4.39 OCINumberSub()
1つのOracle NUMBER
を別のOracle NUMBER
から減算します。
用途
1つのOracle NUMBER
を別のOracle NUMBER
から減算します。
構文
sword OCINumberSub ( OCIError *err, const OCINumber *number1, const OCINumber *number2, OCINumber *result );
パラメータ
コメント
number1
からnumber2
を減算し、その結果をresult
に戻します。
戻り値
この関数は、number
引数にNULL
がある場合はエラーを戻します。
関連トピック
28.4.40 OCINumberTan()
Oracle NUMBER
のタンジェントをラジアン単位で計算します。
用途
Oracle NUMBER
のタンジェントをラジアン単位で計算します。
構文
sword OCINumberTan ( OCIError *err, const OCINumber *number, OCINumber *result );
パラメータ
戻り値
この関数は、NUMBER
引数にNULL
がある場合はエラーを戻します。
28.4.41 OCINumberToInt()
Oracle NUMBER
型を整数に変換します。
用途
Oracle NUMBER
型を整数に変換します。
構文
sword OCINumberToInt ( OCIError *err, const OCINumber *number, uword rsl_length, uword rsl_flag, void *rsl );
パラメータ
- err (IN/OUT)
-
OCIエラー・ハンドルです。エラーがある場合は、
err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()
をコールして診断情報を取得します。 - number (IN)
-
変換するOracle
NUMBER
です。 - rsl_length (IN)
-
適切な結果のサイズです。
- rsl_flag (IN)
-
出力値の符号を指定するフラグで、可能な値は次のとおりです。
-
OCI_NUMBER_UNSIGNED
- 符号なしの値 -
OCI_NUMBER_SIGNED
- 符号付きの値
コメント
これは、システム固有な型変換関数です。指定のOracle NUMBER
をub2
、ub4
、sb2
など、xbn
という書式の整数に変換します。
戻り値
この関数は、number
またはrsl
がNULL
の場合、number
が大きすぎる(オーバーフロー)か小さすぎる(アンダーフロー)場合、または無効な符号フラグの値がrsl_flag
に渡された場合にエラーを戻します。
関連トピック
28.4.42 OCINumberToReal()
Oracle NUMBER
型を実数型に変換します。
用途
Oracle NUMBER
型を実数型に変換します。
構文
sword OCINumberToReal ( OCIError *err, const OCINumber *number, uword rsl_length, void *rsl );
パラメータ
コメント
これは、システム固有な型変換関数です。Oracle NUMBER
をシステム固有の実数型に変換します。この関数は、最大LDBL_DIG、DBL_DIGまたはFLT_DIG桁の精度のNUMBER
を変換し、後続の0 (ゼロ)を削除するだけです。これらの定数は、float.h
に定義されます。
この関数に有効なOCINumber
の値を渡す必要があります。それ以外の場合は、結果は保証されません。
関連トピック
28.4.43 OCINumberToRealArray()
NUMBER
の配列を実数型の配列に変換します。
用途
NUMBER
の配列を実数型の配列に変換します。
構文
sword OCINumberToRealArray ( OCIError *err, const OCINumber **number, uword elems, uword rsl_length, void *rsl );
パラメータ
コメント
Oracle NUMBER
をマシン固有の実数型に変換するシステム固有な型変換関数です。この関数は、最大LDBL_DI
G
、DBL_DIG
またはFLT_DIG
桁の精度のNUMBERを変換し、後続の0 (ゼロ)を削除するだけです。この定数は、float.h
ヘッダー・ファイルに定義されます。
この関数に有効なOCINumber
の値を渡す必要があります。それ以外の場合は、結果は保証されません。
戻り値
OCI_SUCCESS
(関数が正常に完了した場合)、OCI_INVALID_HANDLE
(err
がNULL
の場合)、OCI_ERROR
(number
またはrsl
がNULL
の場合、あるいはrsl_length
が0の場合)。
関連トピック
28.4.44 OCINumberToText()
指定された書式に従って、Oracle NUMBER
を文字列に変換します。
用途
指定された書式に従って、Oracle NUMBER
を文字列に変換します。
構文
sword OCINumberToText ( OCIError *err, const OCINumber *number, const OraText *fmt, ub4 fmt_length, const OraText *nls_params, ub4 nls_p_length, ub4 *buf_size, OraText *buf );
パラメータ
- err (IN/OUT)
-
OCIエラー・ハンドルです。エラーがある場合は、
err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()
をコールして診断情報を取得します。 - number (IN)
-
変換するOracle
NUMBER
です。 - fmt (IN)
-
変換書式です。
- fmt_length (IN)
-
fmt
パラメータの長さです。 - nls_params (IN)
-
グローバリゼーション・サポートのフォーマット指定です。
NULL
文字列((text *)0
)の場合は、そのセッションのデフォルト・パラメータが使用されます。 - nls_p_length (IN)
-
nls_params
パラメータの長さです。 - buf_size (IN)
-
バッファのサイズです。
- buf (OUT)
-
変換された文字列が配置されるバッファです。
コメント
書式およびグローバリゼーション・サポート・パラメータの詳細は、『Oracle Database SQL言語リファレンス』のTO_NUMBER
変換関数の説明を参照してください。
変換された数字文字列は、最大buf_size
バイトまでbuf
に格納されます。
戻り値
この関数は、次の場合にエラーを戻します。
-
number
またはbuf
の値がNULL
である場合 -
バッファが小さすぎる場合
-
書式またはマルチバイト・フォーマットが無効である場合
-
数値を指定の書式のテキストに翻訳するときにオーバーフローが発生した場合
関連トピック