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