LocalPort Property

The TCP port in the local host where IPPort binds.

Syntax

• C++
• Objective-C
• C

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_TELNET_LOCALPORT 18

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

Default Value

0

Remarks

The LocalPort property must be set before a connection is attempted. 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 a connection is made. Any attempt to set the LocalPort property when a connection 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