30.5 カートリッジ・サービス — パラメータ・マネージャ・インタフェース

カートリッジ・サービスのパラメータ・マネージャ・インタフェース関数をリストし、説明します。

表30-4は、この項で説明しているパラメータ・マネージャ・インタフェース関数を示しています。

表30-4 パラメータ・マネージャ・インタフェース関数

関数	用途
OCIExtractFromFile()	指定したファイルのキーおよびそのキーの値を処理します。
OCIExtractFromList()	パラメータ・リストのindexに示されるパラメータの値のリストを生成します。
OCIExtractFromStr()	指定した文字列のキーおよびそのキーの値を処理します。
OCIExtractInit()	パラメータ・マネージャを初期化します。
OCIExtractReset()	メモリーを再初期化します
OCIExtractSetKey()	キーに関する情報をパラメータ・マネージャに登録します。
OCIExtractSetNumKeys()	登録されるキー数をパラメータ・マネージャに通知します。
OCIExtractTerm()	動的に割り当てたすべての記憶域を解放します。
OCIExtractToBool()	指定されたキーのブール値を取得します。
OCIExtractToInt()	指定されたキーの整数値を取得します。
OCIExtractToList()	メモリーに格納されているパラメータ構造からパラメータのリストを生成します。
OCIExtractToOCINum()	指定されたキーの数値を取得します。
OCIExtractToStr()	指定されたキーの文字列値を取得します。

関連項目:

これらの関数の使用方法の詳細は、『Oracle Databaseデータ・カートリッジ開発者ガイド』を参照してください

30.5.1 OCIExtractFromFile()

指定したファイルのキーおよびそのキーの値を処理します。

用途

指定したファイルのキーおよびそのキーの値を処理します。

構文

sword OCIExtractFromFile( void     *hndl, 
                          OCIError *err, 
                          ub4       flag, 
                          OraText  *filename );

パラメータ

hndl (IN/OUT)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

flag (IN)

0 (ゼロ)または次の1つ以上のビットを設定します。

OCI_EXTRACT_CASE_SENSITIVE

OCI_EXTRACT_UNIQUE_ABBREVS

OCI_EXTRACT_APPEND_VALUES

filename (IN)

NULLで終了するファイル名文字列です。

コメント

このルーチンをコールする前に、OCIExtractSetNumKeys()およびOCIExtractSetKey()関数をコールしてすべてのキーを定義する必要があります。

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLEまたはOCI_ERROR。

30.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。

30.5.3 OCIExtractFromStr()

指定した文字列のキーおよびそのキーの値を処理します。

用途

指定した文字列のキーおよびそのキーの値を処理します。

構文

sword OCIExtractFromStr( void     *hndl, 
                         OCIError *err, 
                         ub4       flag, 
                         OraText  *input );

パラメータ

hndl (IN/OUT)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

flag (IN)

0 (ゼロ)または次の1つ以上のビットを設定します。

OCI_EXTRACT_CASE_SENSITIVE

OCI_EXTRACT_UNIQUE_ABBREVS

OCI_EXTRACT_APPEND_VALUES

input (IN)

NULLで終了する入力文字列です。

コメント

このルーチンをコールする前に、OCIExtractSetNumKeys()およびOCIExtractSetKey()関数をコールしてすべてのキーを定義する必要があります。

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLEまたはOCI_ERROR。

30.5.4 OCIExtractInit()

パラメータ・マネージャを初期化します。

用途

パラメータ・マネージャを初期化します。

構文

sword OCIExtractInit( void      *hndl,
                      OCIError  *err);

パラメータ

hndl (IN/OUT)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

コメント

この関数は、他のパラメータ・マネージャ・ルーチンをコールする前にコールする必要があります。また、コールは1度しか実行できません。グローバリゼーション・サポート情報はパラメータ・マネージャ・コンテキストの内部に格納されており、OCIExtract関数の後続のコールで使用されます。

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLEまたはOCI_ERROR。

30.5.5 OCIExtractReset()

パラメータ・ストレージ、キー定義ストレージおよびパラメータ値リスト用に現在使用されているメモリーを解放して構造を再初期化します。

用途

パラメータ・ストレージ、キー定義ストレージおよびパラメータ値リスト用に現在使用されているメモリーを解放して構造を再初期化します。

構文

sword OCIExtractReset( void      *hndl, 
                       OCIError  *err );

パラメータ

hndl (IN/OUT)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLEまたはOCI_ERROR。

30.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。

30.5.7 OCIExtractSetNumKeys()

登録されるキー数をパラメータ・マネージャに通知します。

用途

登録されるキー数をパラメータ・マネージャに通知します。

構文

sword OCIExtractSetNumKeys( void    *hndl, 
                            CIError *err, 
                            uword    numkeys );

パラメータ

hndl (IN/OUT)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

numkeys (IN)

OCIExtractSetKey()で登録されるキー数です。

コメント

このルーチンはOCIExtractSetKey()の最初のコールの前にコールする必要があります。

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLEまたはOCI_ERROR。

30.5.8 OCIExtractTerm()

動的に割り当てたすべての記憶域を解放します。

用途

動的に割り当てたすべての記憶域を解放します。

構文

sword OCIExtractTerm( void      *hndl, 
                      OCIError  *err );

パラメータ

hndl (IN/OUT)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

コメント

この関数は、他の内部ブックキーピング関数を実行する場合があります。また、パラメータ・マネージャが使用されなくなったときにコールする必要があります。また、コールは1度しか実行できません。

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLEまたはOCI_ERROR。

30.5.9 OCIExtractToBool()

指定されたキーのブール値を取得します。

用途

valno値(0から開始)が戻されます。

構文

sword OCIExtractToBool( void      *hndl, 
                        OCIError  *err, 
                        OraText   *keyname, 
                        uword      valno, 
                        ub1       *retval );

パラメータ

hndl (IN)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

keyname (IN)

キー名です。

valno (IN)

このキーで取得する値です。

retval (OUT)

実際のブール値です。

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLE、OCI_NO_DATAまたはOCI_ERROR。

OCI_NO_DATAは、このキーにはvalno値がないことを意味します。

30.5.10 OCIExtractToInt()

指定されたキーの整数値を取得します。

用途

valno値(0から開始)が戻されます。

構文

sword OCIExtractToInt( void      *hndl, 
                       OCIError  *err, 
                       OraText   *keyname, 
                       uword      valno, 
                       sb4       *retval );

パラメータ

hndl (IN)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

keyname (IN)

キー名(IN)です。

valno (IN)

このキーで取得する値です。

retval (OUT)

実際の整数値です。

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLE、OCI_NO_DATAまたはOCI_ERROR。

OCI_NO_DATAは、このキーにはvalno値がないことを意味します。

30.5.11 OCIExtractToList()

メモリーに格納されているパラメータ構造からパラメータのリストを生成します。

用途

OCIExtractValues()をコールする前にコールする必要があります。

構文

sword OCIExtractToList( void      *hndl,
                        OCIError  *err, 
                        uword     *numkeys );

パラメータ

hndl (IN)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

numkeys (OUT)

メモリーに格納されている個別キーの数です。

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLEまたはOCI_ERROR。

30.5.12 OCIExtractToOCINum()

指定されたキーのOCINumber値を取得します。

用途

valno値(0から開始)が戻されます。

構文

sword OCIExtractToOCINum( void      *hndl, 
                          OCIError  *err, 
                          OraText   *keyname, 
                          uword      valno, 
                          OCINumber *retval );

パラメータ

hndl (IN)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

keyname (IN)

キー名です。

valno (IN)

このキーで取得する値です。

retval (OUT)

実際のOCINumber値です。

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLE、OCI_NO_DATAまたはOCI_ERROR。

OCI_NO_DATAは、このキーにはvalno値がないことを意味します。

30.5.13 OCIExtractToStr()

指定されたキーの文字列値を取得します。

用途

valno値(0から開始)が戻されます。

構文

sword OCIExtractToStr( void       *hndl, 
                       OCIError   *err, 
                       OraText    *keyname, 
                       uword       valno, 
                       OraText    *retval, 
                       uword       buflen );

パラメータ

hndl (IN)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN/OUT)

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

keyname (IN)

キー名です。

valno (IN)

このキーで取得する値です。

retval (OUT)

NULLで終了する実際の文字列値です。

buflen

retvalのバッファの長さです。

戻り値

OCI_SUCCESS、OCI_INVALID_HANDLE、OCI_NO_DATAまたはOCI_ERROR。

OCI_NO_DATAは、このキーにはvalno値がないことを意味します。