LocalPort Property

The UDP port in the local host where UDPPort binds.

Syntax

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort); Unicode (Windows) INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);
@property (nonatomic,readwrite,assign,getter=localPort,setter=setLocalPort:) int localPort;
- (int)localPort;
- (void)setLocalPort:(int)newLocalPort;
#define PID_UDPPORT_LOCALPORT 6

IPWORKS_EXTERNAL void* IPWORKS_CALL IPWorks_UDPPort_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_UDPPort_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

0

Remarks

The LocalPort property must be set before UDPPort is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the TCP/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

The LocalPort property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 C++ Edition - Version 20.0 [Build 8307]