PvGetMkdeClientHandleInfo()

Distributed Tuning Interface Reference : PvGetMkdeClientHandleInfo()

Query the information for a MicroKernel Engine client handle associated with 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 PvGetMkdeClientHandleInfo(

BTI_LONG hConnection,

PVCLIENTID* pClientId,

BTI_ULONG sequence,

PVMKDECLIENTHDLINFO* pClientHdlInfo);

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.
In	sequence	The sequence number (zero based) of the client handle. Must be within a valid range with upper limit defined by the number of handles obtained by PvGetMkdeClientHandlesData().
Out	pClientHdlInfo	Address of a PVMKDECLIENTHDLINFO structure to receive the information on the client handle.

Return Values

P_OK	The operation was successful.
P_E_NULL_PTR	Call with NULL pointer.
P_E_INVALID_HANDLE	Invalid connection handle.
P_E_INVALID_CLIENT	Invalid client ID.
P_E_INVALID SEQUENCE	Sequence number is not valid.
P_E_FAIL	Failed to disconnect to the named server.
P_E_DATA_UNAVAILABLE	Data related to active clients not available.

Remarks

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.

•Data for active MicroKernel Engine clients retrieved by calling PvGetMkdeClientsData();

•Data for MicroKernel Engine client handles retrieved by calling PvGetMkdeClientHandlesData();

•Caller already has a valid active MicroKernel Engine client ID.

•Caller already has a valid handle sequence for the active MicroKernel Engine client.