UnregisterTCPServer

int UnregisterTCPServer (unsigned int portNumber);

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.

Parameters

Input
Name Type Description
portNumber unsigned integer 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 RegisterTCPServer function.

Return Value

Name Type Description
status integer 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 Library error codes. To obtain the correct system error message, you must call GetTCPSystemErrorString immediately after calling the TCP Library function that failed.

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.