PvGetMkdeClientsData()
Retrieves all the information related to the active MicroKernel Engine clients.
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 PvGetMkdeClientsData(
BTI_LONG hConnection,
BTI_ULONG_PTR pCount);
Arguments
In | hConnection | Connection handle that identifies the server. Connection handles are obtained with the
PvConnectServer() function. |
Out | pCount | Address of an unsigned long to receive the number of active MicroKernel Engine clients. |
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
When you call this function, all information regarding MicroKernel Engine clients is cached by DTI for subsequent function calls related to clients. The one exception is information regarding client handles, which is cached using a similar function
PvGetMkdeClientHandlesData().
This function should be called first before calling any other functions that return client information. The caller should call
PvFreeMkdeClientsData() to free the cached information when it is no longer needed.
This function can also be called to refresh the cached information.
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