Distributed Tuning Interface のリファレンス : PvGetAllPossibleSelections()
 
このページをシェアする                  
PvGetAllPossibleSelections()
選択タイプ(PVSETTING_SINGLE_SEL または PVSETTING_MULTI_SEL)の設定で使用可能な選択肢をすべて取得します。
ヘッダー ファイル:config.h(ヘッダー ファイルも参照)
関数が最初に利用可能になるライブラリ:w3dbav75.dll(Windows)、libpsqldti.so(Linux)、libpsqldti.dylib(macOS)(リンク ライブラリも参照)
構文
BTI_SINT PvGetAllPossibleSelections(
   BTI_LONG           hConnection,
   BTI_ULONG          settingID,
   BTI_ULONG_PTR      pNumItems,
   BTI_ULONG_PTR      pSelectionList);
引数
 
In
hConnection
サーバーを識別する接続ハンドル。接続ハンドルは PvConnectServer() 関数によって取得されます。
In
settingID
設定の一意な識別子。設定の一覧は、PvGetSettingList() から取得できます。
In/Out
pNumItems
選択項目の総数を受け取る符号なし Long 型のアドレス。選択項目の数は、PvCountSelectionItems() を呼び出して取得することもできます。
Out
pSelectionList
使用可能な選択肢すべてを含む配列。
戻り値
 
P_OK
操作は成功しました。
P_E_INVALID_HANDLE
接続ハンドルが無効です。
P_E_NULL_PTR
ヌル ポインターによる呼び出しです。
P_E_INVALID_DATA_TYPE
要求された設定は選択タイプの設定ではありません。
P_E_BUFFER_TOO_SMALL
配列のサイズが小さすぎます。この場合、必要なサイズが pNumItems に返されます。
P_E_FAIL
その他の理由により失敗しました。
備考
以下の前提条件を満たす必要があります。
PvConnectServer() によって接続が確立している。ただし、ローカル マシンで操作を実行する場合は、接続ハンドルとして P_LOCAL_DB_CONNECTION を使用できます。
関連項目
PvStart()
PvConnectServer()
PvGetCategoryList()
PvGetSettingList()
PvCountSelectionItems()
PvDisconnect()
PvStop()