PvCountSelectionItems()

Distributed Tuning Interface Reference : PvCountSelectionItems()

Count the number of selection items 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 (macOS) (See also Link Libraries)

Syntax

BTI_SINT PvCountSelectionItems(

BTI_LONG hConnection,

BTI_ULONG settingID,

BTI_ULONG_PTR pNumItems);

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 categories can be obtained with the PvGetCategoryList() function. A list of settings for a particular category can be obtained from PvGetSettingList().
Out	pNumItems	Address of an unsigned long that receives the number of selection items.

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_FAIL	Failed for other reasons.

Remarks

The following preconditions must be met:

•DTI session started by calling PvStart().

•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.