システム・モニター 手引きおよび解説書

db2MonitorSwitches - モニターのスイッチの取得 / 更新

データベース・マネージャーが収集するモニター・データのグループのスイッチを選択的にオンまたはオフにします。 呼び出しを出しているアプリケーションに対しては、 これらのスイッチの現行状態を戻します。

効力範囲

この API はそれが実行されたノードの情報だけを戻します。

許可

以下のいずれかになります。

必須接続

インスタンス。 インスタンスの接続がない場合は、 省略時のインスタンス接続が作成されます。

リモート・インスタンス (または別のローカル・インスタンス) の設定を表示するには、 そのインスタンスに最初に接続する必要があります。

db2ApiDf.h

C API 構文

int db2MonitorSwitches (db2Uint32 version,
                             void* pParamStruct,
                             struct sqlca* sqlca);
 
typedef struct
{
        struct sqlm_recording_group     *piGroupStates;
        void                            *poBuffer; 
        db2Uint32                       iBufferSize;
        db2Uint32                       iReturnData;
        db2Uint32                       iVersion;
        db2int32                        iNodeNumber;
        db2Uint32                       *poOutputFormat;
}db2MonitorSwitchesData;

API パラメーター

version
入力。 2 番目のパラメーター pParamStruct として渡される構造体のバージョンとリリース・レベルを指定します。

pParamStruct
入力。 db2MonitorSwitchesStruct 構造体へのポインター。

sqlca
出力。 sqlca 構造体へのポインター。

piGroupStates
入力。 スイッチのリストが入った構造体へのポインター。

poBuffer
スイッチの状態データが書き込まれるバッファーへのポインター。

iBufferSize
入力。 出力バッファーのサイズを指定します。

iReturnData
入力。 現在のスイッチの状態を poBuffer によってポイントされているバッファーに書き込む必要があるかどうかを指定するフラグ。

iVersion
入力。 収集するデータベース・モニター・データのバージョン ID。 データベース・モニターは、要求されたバージョンで使用可能なデータだけを戻します。 このパラメーターは以下の記号定数のいずれかに設定してください。

注:バージョンが SQLM_DBMON_VERSION1 と指定された場合は、 API はリモートで実行できません。

iNodeNumber
入力。 要求が送信されるノード。 この値に基づき、現在のノード、すべてのノード、 またはユーザーが指定したノードで要求が処理されます。 有効値は以下のとおりです。

注:スタンドアロン・インスタンスの場合、 SQLM_CURRENT_NODE を使用する必要があります。

poOutputFormat
サーバーが戻すストリームの形式。 これは、以下のいずれかになります。

SQLM_STREAM_STATIC_FORMAT
スイッチが、バージョン 7 以前のスイッチ構造体で、静的状態で戻されることを示します。

SQLM_STREAM_DYNAMIC_FORMAT
db2GetSnapshot で戻される形式と同じように、 スイッチが自己記述形式で戻されることを示します。
注:データベース・モニター API の使用方法の詳細について、 およびデータベース・モニターのすべてのデータ要素とモニター・グループの要約については、 システム・モニター 手引きおよび解説書 を参照してください。

使用上の注意

データベース・マネージャー・レベルのスイッチの状態を取得するためには、 OBJ_TYPESQMA_DB2 を指定して、 db2GetSnapshot - スナップショットの取得を呼び出します (データベース・マネージャーのスナップショット取得)。

データベース・モニター API の使用方法の詳細について、 およびデータベース・モニターのすべてのデータ要素とモニター・グループの要約については、 システム・モニター 手引きおよび解説書 を参照してください。

追加情報

db2GetSnapshot - スナップショットの取得

db2GetSnapshotSize - db2GetSnapshot() 出力バッファーの必要サイズの見積もり

db2ResetMonitor - モニターのリセット


[ ページのトップ | 前ページ | 次ページ | 目次 | 索引 ]