PvGetCategoryInfo()

Retrieves information about a category of engine settings.

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 PvGetCategoryInfo(

BTI_LONG hConnection,

BTI_ULONG categoryID,

PVCATEGORYINFO* pCatInfo);

Arguments


In	hConnection	Connection handle that identifies the server. Connection handles are obtained with the PvConnectServer() function.
In	categoryID	Unique identifier for the category. You can obtain a list of identifiers via the PvGetCategoryList() function.
Out	pCatInfo	Address of a PVCATEGORYINFO structure that will receive the category information.

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

Remarks

The following precondition 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.

The number of settings returned in the PVCATEGORYINFO structure represents the total number of settings for that category, both client and server. To get the applicable number of settings, call PvGetSettingList(). If it is a remote connection, the server side settings are not applicable.