PvGetMkdeClientId()

Distributed Tuning Interface Reference : PvGetMkdeClientId()

PvGetMkdeClientId()

Get the client ID of an active MicroKernel Engine 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 PvGetMkdeClientId(

BTI_LONG hConnection,

BTI_ULONG sequence,

PVCLIENTID* pClientId);

Arguments

In	hConnection	Connection handle that identifies the server. Connection handles are obtained with the PvConnectServer() function.
In	sequence	The sequence number (zero based) of the MicroKernel Engine client. Must be within a valid range with upper limit returned by PvGetMkdeClientsData().
Out	pClientId	Address of the PVCLIENTID structure to hold the returned client ID information.

Return Values

P_OK	The operation was successful.
P_E_INVALID_HANDLE	Invalid connection handle.
P_E_DATA_UNAVAILABLE	Data related to active clients not available.
P_E_NULL_PTR	Call with NULL pointer.
P_E_INVALID_SEQUENCE	Sequence number is not valid.
P_E_FAIL	Failed for other reasons.

Remarks

The following preconditions must be met:

•DTI session started by calling PvStart().

•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 clients retrieved by calling PvGetMkdeClientsData()