UnregisterTCPServerEx
- Updated2023-02-21
- 2 minute(s) read
UnregisterTCPServerEx
int UnregisterTCPServerEx (unsigned int portNumber, const char localhostAddress[]);
Purpose
Unregisters your program as a TCP server.
No further service is provided. All connections with clients are closed. The server callback function is no longer called for this port number and localhost address combination.
Parameters
Input | ||
Name | Type | Description |
portNumber | unsigned int | The port number under which your program was registered as a TCP server. You must pass the same port number that you passed to the RegisterTCPServerEx function. |
localhostAddress | const char [] | The address of the localhost network interface under which your program was registered as a TCP server. You must pass the same address that you passed to the RegisterTCPServerEx function. |
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 7.1 and later