ODABAClient :: KillClient - Kill client on the server
The function allows killing one or all clients on the server. When killing all clients the client sending the command is not killed.
Before killing the client(s) the system is waiting wait_sec seconds.
Return value: Success ( logical )
Implementation details
logical
ODABAClient :: KillClient ( int32 client_id, int32 wait_sec=300, logical send_message=YES )
- client_id
- Client session number
The client number is an internal number the server has assigned to the client while connecting. You can retrieve client numbers by using the GetClientHandle() function which returns client information for all active clients.
- wait_sec
- Number of seconds to wait
The system waits the given number of seconds before executing the request.
Default: 300
- send_message
- Send message to clients going to be killed
The option must be set to true in order to sent a message to the clients going to be killed. Otherwise (false) clients are killed without warning.
Default: YES