PvGetSettingList()

Retrieves a list of settings belonging to the specified category.

Header file: CONFIG.HRequires: W3DBAV75.DLL or higher version

Syntax

BTI_SINT PvGetSettingList( 
	BTI_LONG           hConnection, 
	BTI_ULONG          categoryID, 
	BTI_ULONG_PTR      pNumSettings, 
	BTI_ULONG_PTR      pSettingList);

Arguments


In	hConnection	Connection handle that identifies the server. Connection handles are obtained with the PvConnectServer() function.
In	categoryID	Unique identifier for the category
Out	pNumSettings	Address of an unsigned long containing size of the array on input, and receives number of items in the returned list.
Out	pSettingList	Pointer to the list of returned setting IDs.

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_BUFFER_TOO_SMALL	The array size is too small. In this case, the required size is returned in pNumSettings.
P_E_FAIL	Failed for other reasons.

Remarks

If the connection is a remote connection, only server-side settings for the category are returned. If the connection is a local connection, both client-side and server-side settings for this category will be returned.

Use PvIsSettingAvailable() to determine if the setting can be set at this time.

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.