PvGetCategoryList()
Retrieves the list of categories of a settings 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) (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 size of buffer allocated to receive category list. Receives actual size of setting values.
Out
pCategoryList
List of category IDs returned.
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.
See Also
PvStart()
PvConnectServer()
PvGetCategoryInfo()
PvDisconnect()
PvStop()