29.5 カートリッジ・サービス — パラメータ・マネージャ・インタフェース
カートリッジ・サービスのパラメータ・マネージャ・インタフェース関数をリストし、説明します。
表29-4は、この項で説明しているパラメータ・マネージャ・インタフェース関数を示しています。
表29-4 パラメータ・マネージャ・インタフェース関数
関数 | 用途 |
---|---|
指定したファイルのキーおよびそのキーの値を処理します。 |
|
パラメータ・リストの |
|
指定した文字列のキーおよびそのキーの値を処理します。 |
|
パラメータ・マネージャを初期化します。 |
|
メモリーを再初期化します |
|
キーに関する情報をパラメータ・マネージャに登録します。 |
|
登録されるキー数をパラメータ・マネージャに通知します。 |
|
動的に割り当てたすべての記憶域を解放します。 |
|
指定されたキーのブール値を取得します。 |
|
指定されたキーの整数値を取得します。 |
|
メモリーに格納されているパラメータ構造からパラメータのリストを生成します。 |
|
指定されたキーの数値を取得します。 |
|
指定されたキーの文字列値を取得します。 |
関連項目:
これらの関数の使用方法の詳細は、『Oracle Databaseデータ・カートリッジ開発者ガイド』を参照してください
29.5.1 OCIExtractFromFile()
指定したファイルのキーおよびそのキーの値を処理します。
用途
指定したファイルのキーおよびそのキーの値を処理します。
構文
sword OCIExtractFromFile( void *hndl, OCIError *err, ub4 flag, OraText *filename );
パラメータ
コメント
このルーチンをコールする前に、OCIExtractSetNumKeys()
およびOCIExtractSetKey()
関数をコールしてすべてのキーを定義する必要があります。
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
またはOCI_ERROR
。
29.5.2 OCIExtractFromList()
パラメータ・リストの索引で示されるパラメータの値のリストを生成します。
用途
パラメータ・リストの索引で示されるパラメータの値のリストを生成します。
構文
sword OCIExtractFromList( void *hndl, OCIError *err, uword index, OraText **name, ub1 *type, uword *numvals, void ***values );
パラメータ
- hndl (IN)
-
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
- err (IN/OUT)
-
OCIエラー・ハンドルです。エラーがある場合は、
err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()
のコールによって診断情報を取得できます。 - index (IN)
-
パラメータ・リストから取り出すパラメータを示します。
- name (OUT)
-
現行のパラメータのキー名です。
- type (OUT)
-
現行のパラメータの型です。
OCI_EXTRACT_TYPE_STRING
OCI_EXTRACT_TYPE_INTEGER
OCI_EXTRACT_TYPE_OCINUM
OCI_EXTRACT_TYPE_BOOLEAN
- numvals (OUT)
-
このパラメータの値の数です。
- values (OUT)
-
このパラメータの値です。
コメント
OCIExtractToList()
は、このルーチンのコールの前にコールして、メモリーに格納されているパラメータ構造からパラメータ・リストを生成する必要があります。
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
またはOCI_ERROR
。
関連トピック
29.5.3 OCIExtractFromStr()
指定した文字列のキーおよびそのキーの値を処理します。
用途
指定した文字列のキーおよびそのキーの値を処理します。
構文
sword OCIExtractFromStr( void *hndl, OCIError *err, ub4 flag, OraText *input );
パラメータ
コメント
このルーチンをコールする前に、OCIExtractSetNumKeys()
およびOCIExtractSetKey()
関数をコールしてすべてのキーを定義する必要があります。
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
またはOCI_ERROR
。
29.5.4 OCIExtractInit()
パラメータ・マネージャを初期化します。
用途
パラメータ・マネージャを初期化します。
構文
sword OCIExtractInit( void *hndl,
OCIError *err);
パラメータ
コメント
この関数は、他のパラメータ・マネージャ・ルーチンをコールする前にコールする必要があります。また、コールは1度しか実行できません。グローバリゼーション・サポート情報はパラメータ・マネージャ・コンテキストの内部に格納されており、OCIExtract
関数の後続のコールで使用されます。
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
またはOCI_ERROR
。
関連トピック
29.5.5 OCIExtractReset()
パラメータ・ストレージ、キー定義ストレージおよびパラメータ値リスト用に現在使用されているメモリーを解放して構造を再初期化します。
用途
パラメータ・ストレージ、キー定義ストレージおよびパラメータ値リスト用に現在使用されているメモリーを解放して構造を再初期化します。
構文
sword OCIExtractReset( void *hndl, OCIError *err );
パラメータ
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
またはOCI_ERROR
。
関連トピック
29.5.6 OCIExtractSetKey()
キーに関する情報をパラメータ・マネージャに登録します。
用途
キーに関する情報をパラメータ・マネージャに登録します。
構文
sword OCIExtractSetKey( void *hndl, OCIError *err, const text *name, ub1 type, ub4 flag, const void *defval, const sb4 *intrange, const text *strlist );
パラメータ
- hndl (IN/OUT)
-
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
- err (IN/OUT)
-
OCIエラー・ハンドルです。エラーがある場合は、
err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()
のコールによって診断情報を取得できます。 - name (IN)
-
キーの名前です。
- type (IN)
-
次のキーの型です。
OCI_EXTRACT_TYPE_INTEGER
OCI_EXTRACT_TYPE_OCINUM
OCI_EXTRACT_TYPE_STRING
OCI_EXTRACT_TYPE_BOOLEAN
- flag (IN)
-
キーに複数の値を使用できる場合は
OCI_EXTRACT_MULTIPLE
に設定し、それ以外の場合は0 (ゼロ)に設定します。 - defval (IN)
-
キーにデフォルト値を設定します。デフォルト値がない場合は
NULL
です。文字列のデフォルト値は(text*)型、整数のデフォルト値は(sb4*)型およびブール・デフォルト値は(ub1*)型にする必要があります。 - intrange (IN)
-
許容範囲の整数値の開始値および終了値です。キーが整数型でない場合、またはすべての整数値が受け入れ可能な場合は
NULL
になります。 - strlist (IN)
-
0 (ゼロ) (または
NULL
)で終了するキーで受け入れ可能なすべてのテキスト文字列のリストです。キーが文字列型でない場合またはすべてのテキスト値が受け入れ可能である場合はNULL
になります。
コメント
このルーチンはOCIExtractSetNumKeys()
をコールしてからコールし、その後にOCIExtractFromFile()
またはOCIExtractFromStr()
をコールする必要があります。
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
またはOCI_ERROR
。
29.5.7 OCIExtractSetNumKeys()
登録されるキー数をパラメータ・マネージャに通知します。
用途
登録されるキー数をパラメータ・マネージャに通知します。
構文
sword OCIExtractSetNumKeys( void *hndl, CIError *err, uword numkeys );
パラメータ
コメント
このルーチンはOCIExtractSetKey()
の最初のコールの前にコールする必要があります。
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
またはOCI_ERROR
。
関連トピック
29.5.8 OCIExtractTerm()
動的に割り当てたすべての記憶域を解放します。
用途
動的に割り当てたすべての記憶域を解放します。
構文
sword OCIExtractTerm( void *hndl, OCIError *err );
パラメータ
コメント
この関数は、他の内部ブックキーピング関数を実行する場合があります。また、パラメータ・マネージャが使用されなくなったときにコールする必要があります。また、コールは1度しか実行できません。
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
またはOCI_ERROR
。
関連トピック
29.5.9 OCIExtractToBool()
指定されたキーのブール値を取得します。
用途
valno
値(0から開始)が戻されます。
構文
sword OCIExtractToBool( void *hndl, OCIError *err, OraText *keyname, uword valno, ub1 *retval );
パラメータ
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
、OCI_NO_DATA
またはOCI_ERROR
。
OCI_NO_DATA
は、このキーにはvalno
値がないことを意味します。
関連トピック
29.5.10 OCIExtractToInt()
指定されたキーの整数値を取得します。
用途
valno
値(0から開始)が戻されます。
構文
sword OCIExtractToInt( void *hndl, OCIError *err, OraText *keyname, uword valno, sb4 *retval );
パラメータ
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
、OCI_NO_DATA
またはOCI_ERROR
。
OCI_NO_DATA
は、このキーにはvalno
値がないことを意味します。
関連トピック
29.5.11 OCIExtractToList()
メモリーに格納されているパラメータ構造からパラメータのリストを生成します。
用途
OCIExtractValues()
をコールする前にコールする必要があります。
構文
sword OCIExtractToList( void *hndl, OCIError *err, uword *numkeys );
パラメータ
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
またはOCI_ERROR
。
関連トピック
29.5.12 OCIExtractToOCINum()
指定されたキーのOCINumber値を取得します。
用途
valno
値(0から開始)が戻されます。
構文
sword OCIExtractToOCINum( void *hndl, OCIError *err, OraText *keyname, uword valno, OCINumber *retval );
パラメータ
戻り値
OCI_SUCCESS
、OCI_INVALID_HANDLE
、OCI_NO_DATA
またはOCI_ERROR
。
OCI_NO_DATA
は、このキーにはvalno
値がないことを意味します。
関連トピック