db2CfgGet API - データベース・マネージャーまたはデータベース構成パラメーターの取得
特定のデータベース構成ファイル、 またはデータベース・マネージャー構成ファイルにある個々の項目の値を戻します。
スコープ
特定のデータベース構成ファイルに関する情報は、 それが実行されるデータベース・パーティションに対してのみ戻されます。
許可
なし
必要な接続
特定のデータベース構成ファイルの構成パラメーターの現行オンライン値を入手するには、 データベースへの接続が必要です。 データベース・マネージャーの構成パラメーターの現行オンライン値を入手するには、 インスタンスへのアタッチが必要です。 それ以外の場合は、データベースまたはインスタンスへの接続は必要ありません。
API 組み込みファイル
db2ApiDf.h
API およびデータ構造構文
SQL_API_RC SQL_API_FN
db2CfgGet (
db2Uint32 versionNumber,
void * pParmStruct,
struct sqlca * pSqlca);
typedef SQL_STRUCTURE db2Cfg
{
db2Uint32 numItems;
struct db2CfgParam *paramArray;
db2Uint32 flags;
char *dbname;
} db2Cfg;
typedef SQL_STRUCTURE db2CfgParam
{
db2Uint32 token;
char *ptrvalue;
db2Uint32 flags;
} db2CfgParam;
SQL_API_RC SQL_API_FN
db2gCfgGet (
db2Uint32 versionNumber,
void * pParmStruct,
struct sqlca * pSqlca);
typedef SQL_STRUCTURE db2gCfg
{
db2Uint32 numItems;
struct db2gCfgParam *paramArray;
db2Uint32 flags;
db2Uint32 dbname_len;
char *dbname;
} db2gCfg;
typedef SQL_STRUCTURE db2gCfgParam
{
db2Uint32 token;
db2Uint32 ptrvalue_len;
char *ptrvalue;
db2Uint32 flags;
} db2gCfgParam;
db2CfgGet API パラメーター
- versionNumber
- 入力。 2 番目のパラメーター pParmStructとして渡される構造のバージョンとリリースのレベルを指定します。
- pParmStruct
- 入力。 db2Cfg 構造を指すポインター。
- pSqlca
- 出力。 sqlca 構造を指すポインター。
db2Cfg データ構造パラメーター
- numItems
- 入力。 paramArray 配列内の構成パラメーターの数。 paramArray 内のエレメントの最大数を指定する場合は、この値を db2CfgMaxParam に設定します。
- paramArray
- 入力。 db2CfgParam 構造を指すポインター。
- flags
- 入力。 実行するアクションのタイプを指定します。 有効な値 (include ディレクトリーにある db2ApiDf ヘッダー・ファイルで定義されている値) は、以下のとおりです。
- db2CfgDatabase
- データベース構成ファイルの値を戻すために指定します。
- db2CfgDatabaseManager
- データベース・マネージャー構成ファイルの値を戻すために指定します。
- db2CfgImmediate
- メモリーに保管された構成パラメーターの現行値を戻します。
- db2CfgDelayed
- ディスク上の構成パラメーターの値を入手します。 次回のデータベースまたはインスタンス接続までは、これらの値はメモリー内の現行値にはなりません。
- db2CfgGetDefaults
- 構成パラメーターのデフォルト値を戻します。
- dbname
- 入力。 データベース名。
db2CfgParam データ構造パラメーター
- トークン
- 入力。 構成パラメーター ID。
db2CfgParam の token エレメントの有効な項目とデータ・タイプは、『構成パラメーターの要約』にリストされています。
注: Db2® pureScale® 環境での クラスター・キャッシング・ファシリティー 構成パラメーターおよび クラスター・キャッシング・ファシリティー 構造構成パラメーターの取得 (または設定) をサポートするために、追加の db2Cfg トークンが追加されました。 - ptrvalue
- 出力。 構成パラメーターの値。
- flags
- 出力。 要求内の各パラメーターに関する特定の情報を提供します。 有効な値 (include ディレクトリーにある db2ApiDf ヘッダー・ファイルで定義されている値) は、以下のとおりです。
- db2CfgParamAutomatic
- 検索されるパラメーターの値が AUTOMATIC かどうかを示します。 構成パラメーターが AUTOMATIC に設定されているかどうかを確認するには、db2ApiDf.h で定義されているフラグと db2CfgParamAutomatic キーワードによって返される値に対してブール AND 演算を実行します。
- db2CfgParamComputed
- 検索されるパラメーターの値が COMPUTED かどうかを示します。 構成パラメーターが COMPUTED に設定されているかどうかを確認するには、db2ApiDf.h で定義されているフラグと db2CfgParamComputed キーワードによって返される値に対してブール AND 演算を実行します。
これらのキーワードの両方に対するブール AND 演算が false である場合、取得されたパラメーター値が手動で設定されたものであることを意味します。
db2gCfg データ構造固有パラメーター
- dbname_len
- 入力。 dbname パラメーターの長さ (バイト単位)。
db2gCfgParam データ構造固有パラメーター
- ptrvalue_len
- 入力。 ptrvalue パラメーターの長さ (バイト単位)。
使用上の注意
構成パラメーター maxagents と maxcagents は非推奨になりました。 今後のリリースでは、これらの構成パラメーターは完全に除去される予定です。
db2CfgGet API は SQLF_KTN_MAXAGENTS および SQLF_KTN_MAXCAGENTS に関する要求を許容しますが、サーバーが Db2 V9.5 の場合には 0 が戻ります。