PreviousDTI Programmer's Guide (v10) Next

PvGetCategoryList()

Chapter contents

Retrieves the list of categories of a settings on the engine specified by the current connection.

Header file: CONFIG.H
Requires: W3DBAV75.DLL or higher version

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:

See Also

PvStart()
PvConnectServer()
PvGetCategoryInfo()
PvDisconnect()
PvStop()


Chapter contents
Book contents

Prev topic: PvGetCategoryInfo()
Next topic: PvGetCategoryListCount()