PvGetMkdeClientHandlesData()
Retrieves the number of MicroKernel Engine client handles related to an active client.
Header File: monitor.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 PvGetMkdeClientHandlesData(
BTI_LONG hConnection,
BTI_ULONG_PTR pCount);
Arguments
In | hConnection | Connection handle that identifies the server. Connection handles are obtained with the
PvConnectServer() function. |
In | pClientId | Address of the
PVCLIENTID structure to identify the MicroKernel Engine client. |
Out | pCount | Address of an unsigned long to receive the number of handles for the MicroKernel Engine client. |
Return Values
P_OK | The operation was successful. |
P_E_INVALID_HANDLE | Invalid connection handle. |
P_E_DATA_UNAVAILABLE | Data related to MicroKernel Engine clients not available. |
P_E_NULL_PTR | Call with NULL pointer. |
P_E_FAIL | Failed for other reasons. |
Remarks
When you call this function, all information regarding MicroKernel Engine client handles is cached by DTI for subsequent function calls related to client handles. If you want to obtain other information about clients, see
PvGetMkdeClientsData().
This function should be called first before calling any other functions that return client handle information.
The cached information for the MicroKernel Engine client handles will be freed along with the information about the clients when
PvFreeMkdeClientsData() is called.
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.
•Caller already has a valid active MicroKernel Engine client ID.
See Also