表20-4は、この項で説明しているパラメータ・マネージャ・インタフェース関数を示しています。
表20-4 パラメータ・マネージャ・インタフェース関数
関数 | 用途 |
---|---|
|
指定したファイルのキーおよびそのキーの値を処理します。 |
|
パラメータ・リストの |
|
指定した文字列のキーおよびそのキーの値を処理します。 |
|
パラメータ・マネージャを初期化します。 |
|
メモリーを再初期化します。 |
|
キーに関する情報をパラメータ・マネージャに登録します。 |
|
登録されるキー数をパラメータ・マネージャに通知します。 |
|
動的に割り当てたすべての記憶域を解放します。 |
|
指定されたキーのブール値を取得します。 |
|
指定されたキーの整数値を取得します。 |
|
メモリーに格納されているパラメータ構造からパラメータのリストを生成します。 |
|
指定されたキーの数値を取得します。 |
|
指定されたキーの文字列値を取得します。 |
関連項目: これらの関数の使用方法の詳細は、『Oracle Database データ・カートリッジ開発者ガイド』を参照してください。 |
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
0 (ゼロ)または次の1つ以上のビットを設定します。
OCI_EXTRACT_CASE_SENSITIVE
OCI_EXTRACT_UNIQUE_ABBREVS
OCI_EXTRACT_APPEND_VALUES
NULL
で終了するファイル名文字列です。
構文
sword OCIExtractFromList( void *hndl, OCIError *err, uword index, OraText **name, ub1 *type, uword *numvals, void ***values );
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
パラメータ・リストから取り出すパラメータを示します。
現行のパラメータのキー名です。
現行のパラメータの型です。
OCI_EXTRACT_TYPE_STRING
OCI_EXTRACT_TYPE_INTEGER
OCI_EXTRACT_TYPE_OCINUM
OCI_EXTRACT_TYPE_BOOLEAN
このパラメータの値の数です。
このパラメータの値です。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()をコールして診断情報を取得します。
0 (ゼロ)または次の1つ以上のビットを設定します。
OCI_EXTRACT_CASE_SENSITIVE
OCI_EXTRACT_UNIQUE_ABBREVS
OCI_EXTRACT_APPEND_VALUES
NULL
で終了する入力文字列です。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
構文
sword OCIExtractSetKey( void *hndl, OCIError *err, const text *name, ub1 type, ub4 flag, const void *defval, const sb4 *intrange, const text *strlist );
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
キーの名前です。
次のキーの型です。
OCI_EXTRACT_TYPE_INTEGER
OCI_EXTRACT_TYPE_OCINUM
OCI_EXTRACT_TYPE_STRING
OCI_EXTRACT_TYPE_BOOLEAN
キーに複数の値を使用できる場合はOCI_EXTRACT_MULTIPLE
に設定し、それ以外の場合は0 (ゼロ)に設定します。
キーにデフォルト値を設定します。デフォルト値がない場合はNULL
です。文字列のデフォルト値は(text*)型、整数のデフォルト値は(sb4*)型およびブール・デフォルト値は(ub1*)型にする必要があります。
許容範囲の整数値の開始値および終了値です。キーが整数型でない場合、またはすべての整数値が受け入れ可能な場合はNULL
になります。
0 (ゼロ) (またはNULL
)で終了するキーで受け入れ可能なすべてのテキスト文字列のリストです。キーが文字列型でない場合またはすべてのテキスト値が受け入れ可能である場合はNULL
になります。
コメント
このルーチンはOCIExtractSetNumKeys()をコールしてからコールし、その後にOCIExtractFromFile()またはOCIExtractFromStr()をコールする必要があります。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
OCIExtractSetKey()で登録されるキー数です。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
キー名です。
このキーで取得する値です。
実際のブール値です。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
キー名(IN)です。
このキーで取得する値です。
実際の整数値です。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
メモリーに格納されている個別キーの数です。
構文
sword OCIExtractToOCINum( void *hndl, OCIError *err, OraText *keyname, uword valno, OCINumber *retval );
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
キー名です。
このキーで取得する値です。
実際のOCINumber値です。
構文
sword OCIExtractToStr( void *hndl, OCIError *err, OraText *keyname, uword valno, OraText *retval, uword buflen );
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
キー名です。
このキーで取得する値です。
NULL
で終了する実際の文字列値です。
retval
のバッファの長さです。