GetHostTCPSocketHandle

Download PDF

int GetHostTCPSocketHandle (unsigned int conversationHandle, intptr_t *socketHandle);

Purpose

Obtains the system socket handle that corresponds to a TCP Support Library connection.

Input
Name	Type	Description
conversationHandle	unsigned int	TCP Support Library conversation handle that you obtain from ConnectToTCPServer or ConnectToTCPServerEx or receive in a server callback as the handle parameter of a TCP_CONNECT message.
Output
Name	Type	Description
socketHandle	intptr_t	System socket handle for the connection that conversationHandle identifies.

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.

Library: TCP Support Library

Include file: tcpsupp.h

LabWindows/CVI compatibility: LabWindows/CVI 5.0 and later

Was this information helpful?