PvGetCategoryList()

Distributed Tuning Interface Reference : PvGetCategoryList()

PvGetCategoryList()

Retrieves the list of category IDs on the engine specified by the current connection.

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

BTI_LONG hConnection,

BTI_ULONG_PTR pnumCategories,

BTI_ULONG_PTR pCategoriesList);

Arguments

In	hConnection	Connection handle that identifies the server. Connection handles are obtained with the PvConnectServer() function.
In/Out	pnumCategories	Address of an unsigned long containing the number of categories that can be returned in pCategoriesList. You can also call PvGetCategoryListCount() to retrieve this value.
Out	pCategoriesList	Array containing the category 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_FAIL	Failed for other reasons.
P_E_BUFFER_TOO_SMALL	Array size is too small. The required size is returned in pnumCategories.

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.