Distributed Tuning Interface のリファレンス : PvSetStringValue()
 
このページをシェアする                  
PvSetStringValue()
whichData によって指定されるデータ ターゲットに、文字列型の新しい設定値を保存します。
ヘッダー ファイル:config.h(ヘッダー ファイルも参照)
関数が最初に利用可能になるライブラリ:w3dbav75.dll(Windows)、libpsqldti.so(Linux)、libpsqldti.dylib(macOS)(リンク ライブラリも参照)
構文
BTI_SINT PvSetStringValue(
   BTI_LONG           hConnection,
   BTI_ULONG          settingID,
   BTI_CHAR_PTR       newValue,
   BTI_SINT           whichData);
引数
 
In
hConnection
サーバーを識別する接続ハンドル。接続ハンドルは PvConnectServer() 関数によって取得されます。
In
settingID
設定の一意な識別子。設定の一覧は、PvGetSettingList() から取得できます。
In
newValue
設定される文字列値。
In
whichData
どちらの値が設定されるかを示すフラグ。
PVDATA_CURRENT は現在値を設定します。
PVDATA_PERSISTENT は不変値を設定します。
戻り値
 
P_OK
操作は成功しました。
P_E_INVALID_HANDLE
接続ハンドルが無効です。
P_E_NULL_PTR
ヌル ポインターによる呼び出しです。
P_E_INVALID_DATA_TYPE
設定は文字列型の設定ではありません。
P_E_FAIL
その他の理由により失敗しました。
備考
設定によっては、セミコロン(;)で区切られた複数の文字列を取ることがあります。
以下の前提条件を満たす必要があります。
PvConnectServer() によって接続が確立している。ただし、ローカル マシンで操作を実行する場合は、接続ハンドルとして P_LOCAL_DB_CONNECTION を使用できます。
PvConnectServer() を使って管理者レベルの権限でログオンしている。
メモ:この関数は、「制限ユーザー」を使ってログインしているユーザーからは呼び出せません。
関連項目
PvStart()
PvConnectServer()
PvGetCategoryList()
PvGetSettingList()
PvGetStringType()
PvGetStringValue()
PvIsSettingAvailable()
PvDisconnect()
PvStop()