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