Active Property

Enables or disables sending and receiving of data.

Syntax

ANSI (Cross Platform)
int GetActive();
int SetActive(int bActive);

Unicode (Windows)
BOOL GetActive();
INT SetActive(BOOL bActive);
@property (nonatomic,readwrite,assign,getter=active,setter=setActive:) BOOL active;
- (BOOL)active;
- (void)setActive:(BOOL)newActive;

#define PID_UDPPORT_ACTIVE 2

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

FALSE

Remarks

Setting the Active property to True makes the class create a communication endpoint (socket) which can be used for sending and receiving UDP datagrams. Setting it to False destroys the socket and disables data communications.

If UseConnection is set to True, then a local association (connection) to the remote host and port is also created.

This property is not available at design time.

Data Type

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