DisconnectFromTCPServer
- Updated2023-02-21
- 2 minute(s) read
DisconnectFromTCPServer
int DisconnectFromTCPServer (unsigned int conversationHandle);
Purpose
Terminates a connection between the TCP client and the TCP server.
 |
Note DisconnectFromTCPServer terminates only the connection conversationHandle identifies. There can be more than one conversation between a client and a server. |
Parameters
| Input | ||
| Name | Type | Description |
| conversationHandle | unsigned int | The conversation handle that uniquely represents the connection between the server and the client. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. Unless otherwise
stated, zero represents successful execution and a negative number represents
the error code. You can call the GetTCPSystemErrorString function to obtain a system message that describes the error. The system messages can be more descriptive than the TCP Support Library error codes. To obtain the correct system error message, you must call GetTCPSystemErrorString immediately after calling the TCP Support Library function that failed. For RegisterTCPServer and RegisterTCPServerEx, the return value is the port number assigned by the system if you passed zero for the port and the function was successful. For functions that read or write data (ClientTCPRead, ClientTCPWrite, ServerTCPRead, ServerTCPWrite), if the function was successful, the return value is the number of bytes transferred. You can have a maximum of 255 concurrent conversations and up to 1,024 connections. If you exceed this limit, -kTCP_TooManyConnections will be returned. You may not be able to open the maximum number of connections allowed by LabWindows/CVI because of limitations imposed by the operating system. |
Additional Information
Library: TCP Support Library
Include file: tcpsupp.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later
Examples
Refer to the following examples that use the DisconnectFromTCPServer function:
- tcp\client.cws
Open example - tcp\message.cws
Open example - tcp\MultiThreading.cws
Open example