PvSetSelectionValue()
Save new value for a selection 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 (OS X) (See also
Link Libraries
)
Syntax
BTI_SINT PvSetSelectionValue(
BTI_LONG
hConnection,
BTI_ULONG
settingID,
BTI_ULONG
numItems,
BTI_LONG_PTR
pNewValue,
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
numItems
Number of individual selection items to be set.
In
pNewValue
Array of individual selection items to be set.
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_NULL_PTR
Call with NULL pointer.
P_E_INVALID_DATA_TYPE
The setting is not of selection type.
P_E_INVALID_SELECTION
At least one selection item is invalid.
P_E_FAIL
Failed for other reasons.
Remarks
This function is used to work with both single-selection and multi-selection data types. If more than one selection items are set for a single-selection item, the first value is used.
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 Selection type setting.
Note:
This function cannot be called by a user logged-in with the "restricted" user type.
See Also
PvStart()
PvConnectServer()
PvGetCategoryList()
PvGetSettingList()
PvGetSelectionValue()
PvGetSelectionString()
PvGetAllPossibleSelections()
PvCountSelectionItems()
PvIsSettingAvailable()
PvDisconnect()
PvStop()