PvDisconnectMkdeClient()

Distributed Tuning Interface Reference : PvDisconnectMkdeClient()

Attempts to disconnect an active MicroKernel Engine client by specifying a client ID. In order to obtain a valid client ID, use PvGetMkdeClientData and PvGetMkdeClientId functions.

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 PvDisconnectMkdeClient(

BTI_LONG hConnection,

PVCLIENTID* pClientId);

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.

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_CLIENT	Invalid client ID.
P_E_FAIL	Failed to disconnect to the named server.

Example

unsigned long count = 0;

// This sample disconnects all active Mkde connections

BTI_SINT status = 0

PVCLIENTID clientId;

status = PvGetMkdeClientsData(connection, &count);

while (count > 0)

{

status = PvGetMkdeClientId(connection, 0, &client Id);

status = PvDisconnectMkdeClient(connection, &clientId);

status = PvGetMkdeClientsData(connection, &count)

}

PvFreeMkdeClientsData(connection);

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.