MulticastGroup Property

Multicast group to join or leave.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetMulticastGroup();
int SetMulticastGroup(const char* lpszMulticastGroup);

Unicode (Windows)
LPWSTR GetMulticastGroup();
INT SetMulticastGroup(LPCWSTR lpszMulticastGroup);

@property (nonatomic,readwrite,assign,getter=multicastGroup,setter=setMulticastGroup:) NSString* multicastGroup;
- (NSString*)multicastGroup;
- (void)setMulticastGroup:(NSString*)newMulticastGroup;

#define PID_MCAST_MULTICASTGROUP 7

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

Default Value

""

Remarks

This property contains the multicast group to join or leave. Multicast groups are joined by assigning values to this property after the class is activated. More than one group may be joined at the same time. To define which interface to use, the ReceiveInterface property is used.

Determining whether a group is left or joined is done by setting the first letter of MulticastGroup is "-" or "+". The default operation is join.

To remove the class from a multicast group once it is joined, simply assign this groupname (address) to MulticastGroup prefixed by a minus sign "-".

Example (Joining/Leaving Groups)

MCastControl.Active = true
MCastControl.MulticastGroup = "+231.31.31.31"
MCastControl.MulticastGroup = "+232.32.32.32"

MCastControl.MulticastGroup = "-232.32.32.32"
MCastControl.MulticastGroup = "-231.31.31.31"

Data Type

String