setipv4sourcefilter function (ws2tcpip.h)

The setipv4sourcefilter inline function sets the multicast filter state for an IPv4 socket.

Syntax

int setipv4sourcefilter(
  [in] SOCKET              Socket,
  [in] IN_ADDR             Interface,
  [in] IN_ADDR             Group,
  [in] MULTICAST_MODE_TYPE FilterMode,
  [in] ULONG               SourceCount,
  [in] const IN_ADDR       *SourceList
);

Parameters

[in] Socket

A descriptor that identifies a multicast socket.

[in] Interface

The local IPv4 address of the interface or the interface index on which the multicast group should be joined or dropped.

This value is in network byte order. If this member specifies an IPv4 address of 0.0.0.0, the default IPv4 multicast interface is used.

Any IP address in the 0.x.x.x block (first octet of 0) except IPv4 address 0.0.0.0 is treated as an interface index. An interface index is a 24-bit number, and the 0.0.0.0/8 IPv4 address block is not used (this range is reserved).

To use an interface index of 1 would be the same as an IP address of 0.0.0.1.

[in] Group

The IPv4 address of the multicast group.

[in] FilterMode

The multicast filter mode for multicast group address.

[in] SourceCount

The number of source addresses in the buffer pointed to by the SourceList parameter.

[in] SourceList

A pointer to a buffer with the IP addresses to associate with the multicast filter.

Return value

On success, setipv4sourcefilter returns NO_ERROR (0). Any nonzero return value indicates failure and a specific error code can be retrieved by calling WSAGetLastError.

Remarks

The setipv4sourcefilter inline function is used to set the multicast filter state for an IPv4 socket.

This function is part of socket interface extensions for multicast source filters defined in RFC 3678. An app can use these functions to retrieve and set the multicast source address filters associated with a socket.

Windows Phone 8: This function is supported for Windows Phone Store apps on Windows Phone 8 and later.

Windows 8.1 and Windows Server 2012 R2: This function is supported for Windows Store apps on Windows 8.1, Windows Server 2012 R2, and later.

Requirements

See also

MULTICAST_MODE_TYPE

getipv4sourcefilter

getsourcefilter

in_addr

setsourcefilter