PvSetBooleanValue()
Save new value for a Boolean 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 PvSetBooleanValue(
BTI_LONG hConnection,
BTI_ULONG settingID,
BTI_SINT 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. |
In | whichData | Flag to indicate which value is to be set: PVDATA_CURRENT means apply setting changes to current session and save to registry, ini or ncf file. Only valid for Trace Op in Btr 6.15 NT release.
PVDATA_PERSISTENT don’t apply setting change to the current session. Save setting to registry, ini or ncf files only. |
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 Boolean type. |
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 Boolean type setting.
Note This function cannot be called by a user logged-in with the "restricted" user type.
See Also