XenoGuard 4.0 Documentation
TCP Server Remove Client
ActionStep Reference » Windows » Network » TCP » TCP Server Remove Client
The TCP Server Remove Client ActionStep removes a client from the server's list of active clients.
[-] Hide
- Open the Windows node in the Workspace Explorer.
- Open the Network node.
- In the TCP node, select the TCP Server Remove Client ActionStep.
Parameters:
The ActionStep has the following input parameters:
| name |
Description
|
|---|---|
|
Name
|
The name of the TCP server.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter, Enum] |
|
Id
|
The unique client id.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter, Enum] |
Results:
The ActionStep returns the following results:
|
name
|
description
|
|---|---|
|
Result
|
Indicates whether the client was successfully removed from the list.
Allowed Value: Boolean Allowed Context Scope [Fixed]Allowed Context Types [Variable, Parameter] |
Example 1 (Remove a TCP client from the TCP server):
This example runs a TCP server and checks the connected clients in TCP Server Statistic. A specified client is then removed from the list in the server based on the client id. The ActionStep in the "Then" branch is executed if the specified TCP client is removed and is then output via Message Box. Otherwise, the ActionStep in the "Else" branch is executed.
