Distributed Tuning Interface Reference : PvSetLongValue()
 
PvSetLongValue()
Save new value for a long integer type setting, to the data target specified by whichData.
Header File: config.h (See also Header Files)
Function First Available In Library: w3dbav75.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (macOS) (See also Link Libraries)
Syntax
BTI_SINT PvSetLongValue(
   BTI_LONG           hConnection,
   BTI_ULONG          settingID,
   BTI_LONG           newValue,
   BTI_SINT           whichData);
Arguments
 
In
hConnection
Connection handle that identifies the server. Connection handles are obtained with the PvConnectServer() function.
In
settingID
Unique identifier for the setting. A list of settings can be obtained from PvGetSettingList().
In
newValue
Integer value to be set.
Before calling this function, check to see that the value is within the limits for the particular setting by using the PvGetValueLimit() function.
In
whichData
Flag to indicate which value is to be set:
PVDATA_CURRENT sets current value.
PVDATA_PERSISTENT sets persistent value
Return Values
 
P_OK
The operation was successful.
P_E_INVALID_HANDLE
Invalid connection handle.
P_E_INVALID_DATA_TYPE
The setting is not of long type.
P_E_OUT_OF_RANGE
The value specified to be set is out of range.
P_E_FAIL
Failed for other reasons.
Remarks
The following preconditions must be met:
Connection established by PvConnectServer() or if you are performing the operation on a local machine, P_LOCAL_DB_CONNECTION may be used as the connection handle.
You must logon with administrator-level rights with PvConnectServer () before you can set a new value for a Long type setting.
Note This function cannot be called by a user logged-in with the "restricted" user type.
See Also
PvStart()
PvConnectServer()
PvGetCategoryList()
PvGetSettingList()
PvGetLongValue()
PvGetValueLimit()
PvIsSettingAvailable()
PvDisconnect()
PvStop()