Distributed Tuning Interface のリファレンス : PvGetCategoryInfo()
 
このページをシェアする                  
PvGetCategoryInfo()
エンジン設定のカテゴリについての情報を取得します。
ヘッダー ファイル:config.h(ヘッダー ファイルも参照)
関数が最初に利用可能になるライブラリ:w3dbav75.dll(Windows)、libpsqldti.so(Linux)、libpsqldti.dylib(OS X)(リンク ライブラリも参照)
構文
BTI_SINT PvGetCategoryInfo(
   BTI_LONG           hConnection,
   BTI_ULONG          categoryID,
   PVCATEGORYINFO*    pCatInfo);
引数
 
In
hConnection
サーバーを識別する接続ハンドル。接続ハンドルは PvConnectServer()関数によって取得されます。
In
categoryID
カテゴリの一意な識別子。識別子の一覧は、PvGetCategoryList()関数を使って取得できます。
Out
pCatInfo
カテゴリ情報を受け取る PVCATEGORYINFO 構造体のアドレス。
戻り値
 
P_OK
操作は成功しました。
P_E_INVALID_HANDLE
接続ハンドルが無効です。
P_E_NULL_PTR
ヌル ポインターによる呼び出しです。
P_E_FAIL
その他の理由により失敗しました。
備考
以下の前提条件を満たす必要があります。
PvConnectServer()によって接続が確立している。ただし、ローカル マシンで操作を実行する場合は、接続ハンドルとして P_LOCAL_DB_CONNECTION を使用できます。
PVCATEGORYINFO 構造体に返される設定の数は、そのカテゴリについての、クライアントとサーバー両方の設定の総数を表します。適用可能な設定の数を取得するには、PvGetSettingList()を呼び出します。リモート接続の場合、サーバー側の設定は適用できません。
関連項目
PvStart()
PvConnectServer()
PvGetCategoryList()
PvDisconnect()
PvStop()