PvGetAllPossibleSelections()
Retrieves all available selection choices for a setting of types (PVSETTING_SINGLE_SEL or PVSETTING_MULTI_SEL).
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 PvGetAllPossibleSelections(
BTI_LONG
hConnection,
BTI_ULONG
settingID,
BTI_ULONG_PTR
pNumItems,
BTI_ULONG_PTR
pSelectionList
);
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/Out
pNumItems
Address of an unsigned long that receives the total number of selection items. You can also retrieve the number of selection items by calling
PvCountSelectionItems()
Out
pSelectionList
Array that contains all available selection choices.
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 requested setting is not of selection type.
P_E_BUFFER_TOO_SMALL
The array size is too small. In this case, the required size is returned in
pNumItems.
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.
See Also
PvStart()
PvConnectServer()
PvGetCategoryList()
PvGetSettingList()
PvCountSelectionItems()
PvDisconnect()
PvStop()