MULTICAST_MODE_TYPE enumeration (ws2ipdef.h)

  • Article

The MULTICAST_MODE_TYPE enumeration specifies the filter mode for multicast group addresses.

Syntax

typedef enum {
  MCAST_INCLUDE = 0,
  MCAST_EXCLUDE
} MULTICAST_MODE_TYPE;

Constants

 
MCAST_INCLUDE
Value: 0
The filter contains a list of IP addresses to include.
MCAST_EXCLUDE
The filter contains a list of IP addresses to exclude.

Remarks

This enumeration is supported on Windows Vista and later.

The MULTICAST_MODE_TYPE enumeration is used in the gf_fmode member of the GROUP_SOURCE_REQ structure to determine if a list of IP addresses should included or excluded. The values from this enumeration can also be used in the imsf_fmode member of the ip_msfilter structure.

The MULTICAST_MODE_TYPE enumeration is defined in the Ws2ipdef.h header file which is automatically included in the Ws2tcpip.h header file. The Ws2ipdef.h header files should never be used directly.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header ws2ipdef.h

See also

GROUP_REQ

GROUP_SOURCE_REQ

Multicast Programming

Socket Options

ip_mreq

ip_msfilter

ipv6_mreq