GetUDPSocketHandle
int GetUDPSocketHandle (unsigned int channel, intptr_t *socketHandle);
Purpose
Obtains the system socket handle that corresponds to a UDP Support Library channel.
You should not need to use this function. This function provides access to the underlying implementation in case an advanced user needs functionality not exposed through the UDP Support Library functions.
 |
Note If you use the socket handle to alter the multicast memberships of a channel, do not use UDPMulticastSubscribe or UDPMulticastUnsubscribe. |
Parameters
| Input | ||
| Name | Type | Description |
| channel | unsigned int | A handle that uniquely identifies an open UDP communication endpoint. |
| Output | ||
| Name | Type | Description |
| socketHandle | intptr_t | System socket handle for channel. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful.
Zero indicates successful execution and a negative number indicates that an error occurred. Call the GetUDPErrorString function to obtain a message that describes the error. |
Additional Information
Library: UDP Support Library
Include file: udpsupp.h
LabWindows/CVI compatibility: LabWindows/CVI 8.5 and later