Função setsourcefilter (ws2tcpip.h)

Artigo
03/13/2024

A função embutida setsourcefilter define o estado do filtro multicast para um soquete IPv4 ou IPv6.

Sintaxe

int setsourcefilter(
  [in] SOCKET                 Socket,
  [in] ULONG                  Interface,
  [in] const SOCKADDR         *Group,
  [in] int                    GroupLength,
  [in] MULTICAST_MODE_TYPE    FilterMode,
  [in] ULONG                  SourceCount,
  [in] const SOCKADDR_STORAGE *SourceList
);

Parâmetros

[in] Socket

Um descritor que identifica um soquete multicast.

[in] Interface

O índice de interface da interface multicast.

[in] Group

Um ponteiro para o endereço do soquete do grupo multicast.

[in] GroupLength

O comprimento, em bytes, do endereço do soquete apontado pelo parâmetro Group .

[in] FilterMode

O modo de filtro multicast para o endereço do grupo multicast.

[in] SourceCount

O número de endereços de origem no buffer apontado pelo parâmetro SourceList .

[in] SourceList

Um ponteiro para um buffer com os endereços IP a serem associados ao filtro multicast.

Retornar valor

Em caso de êxito, setsourcefilter retorna NO_ERROR (0). Qualquer valor retornado diferente de zero indica falha e um código de erro específico pode ser recuperado chamando WSAGetLastError.

Código do erro	Significado
WSAENOBUFS	Espaço em buffer insuficiente está disponível.
WSAENOTSOCK	O descritor não é um soquete.

Comentários

A função embutida setsourcefilter é usada para definir o estado do filtro multicast para um soquete IPv4 ou IPv6.

Essa função faz parte das extensões de interface do soquete para filtros de origem multicast definidos no RFC 3678. Um aplicativo pode usar essas funções para recuperar e definir os filtros de endereço de origem multicast associados a um soquete.

Windows Phone 8: essa função tem suporte para aplicativos da Windows Phone Store no Windows Phone 8 e posterior.

Windows 8.1 e Windows Server 2012 R2: essa função tem suporte para aplicativos da Windows Store em Windows 8.1, Windows Server 2012 R2 e posteriores.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 8.1, Windows Vista [aplicativos da área de trabalho \| Aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2003 [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	ws2tcpip.h
Biblioteca	Ws2_32.lib
DLL	Ws2_32.dll