Distributed Tuning Interface のリファレンス : PvGetCategoryList()
 
このページをシェアする                  
PvGetCategoryList()
現在の接続によって特定されるエンジンの、カテゴリ ID の一覧を取得します。
ヘッダー ファイル:config.h(ヘッダー ファイルも参照)
関数が最初に利用可能になるライブラリ:w3dbav75.dll(Windows)、libpsqldti.so(Linux)、libpsqldti.dylib(OS X)(リンク ライブラリも参照)
構文
BTI_SINT PvGetCategoryList(
   BTI_LONG           hConnection,
   BTI_ULONG_PTR      pnumCategories,
   BTI_ULONG_PTR      pCategoriesList);
引数
 
In
hConnection
サーバーを識別する接続ハンドル。接続ハンドルは PvConnectServer()関数によって取得されます。
In/Out
pnumCategories
pCategoriesList で返すことができるカテゴリの数を格納する、符号なし Long 型のアドレス。 また、PvGetCategoryListCount()を呼び出すと、この値を取得することができます。
Out
pCategoriesList
カテゴリ ID を格納する配列。
戻り値
 
P_OK
操作は成功しました。
P_E_INVALID_HANDLE
接続ハンドルが無効です。
P_E_NULL_PTR
ヌル ポインターによる呼び出しです。
P_E_FAIL
その他の理由により失敗しました。
P_E_BUFFER_TOO_SMALL
配列のサイズが小さすぎます。 必要なサイズが pnumCategories に返されます。
備考
以下の前提条件を満たす必要があります。
PvConnectServer()によって接続が確立している。ただし、ローカル マシンで操作を実行する場合は、接続ハンドルとして P_LOCAL_DB_CONNECTION を使用できます。
関連項目
PvStart()
PvConnectServer()
PvGetCategoryInfo()
PvDisconnect()
PvStop()