Função FwpmEngineSetOption0 (fwpmu.h)

  • Artigo

A função FwpmEngineSetOption0 altera as configurações do mecanismo de filtro.

Sintaxe

DWORD FwpmEngineSetOption0(
  [in] HANDLE             engineHandle,
  [in] FWPM_ENGINE_OPTION option,
  [in] const FWP_VALUE0   *newValue
);

Parâmetros

[in] engineHandle

Tipo: HANDLE

Manipule para uma sessão aberta para o mecanismo de filtro. Chame FwpmEngineOpen0 para abrir uma sessão para o mecanismo de filtro.

[in] option

Tipo: FWPM_ENGINE_OPTION

A opção a ser definida.

[in] newValue

Tipo: FWP_VALUE0*

O novo valor da opção. O tipo de dados contido no parâmetro newValue deve ser FWP_UINT32.

Quando a opção é FWPM_ENGINE_COLLECT_NET_EVENTS, newValue deve ser um dos seguintes.

Valor Significado
0
 Não colete eventos de rede.
1
 Coletar eventos de rede. Essa é a configuração padrão.
 

Quando a opção é FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS, newValue deve ser 0 (zero) ou uma combinação bit a bit dos valores a seguir.

Nota Se newValue for 0, a coleção de eventos de transmissão e multicast de entrada será desabilitada. Essa é a configuração padrão.
 
Valor Significado
FWPM_NET_EVENT_KEYWORD_INBOUND_MCAST
1
 Coletar eventos de rede multicast de entrada.
FWPM_NET_EVENT_KEYWORD_INBOUND_BCAST
2
 Coletar eventos de rede de transmissão de entrada.
 

Quando a opção é FWPM_ENGINE_PACKET_QUEUING (disponível apenas no Windows 8 e no Windows Server 2012), newValue deve ser um dos seguintes.

Valor Significado
FWPM_ENGINE_OPTION_PACKET_QUEUE_NONE
0
 Não habilite a fila de pacotes.
FWPM_ENGINE_OPTION_PACKET_QUEUE_INBOUND
1
 Habilitar a fila de pacotes de entrada.
FWPM_ENGINE_OPTION_PACKET_QUEUE_OUTBOUND
2
 Habilite a fila de pacotes de saída.
 

Quando a opção é FWPM_ENGINE_MONITOR_IPSEC_CONNECTIONS (disponível apenas no Windows 8 e no Windows Server 2012), newValue deve ser o seguinte. (FwpmEngineSetOption0 pode ser usado para habilitar conexões, mas falhará com FWP_E_STILL_ON ERROR ao tentar desabilitá-lo.)

Valor Significado
1
 O recurso Monitoramento de Conexão IPsec será habilitado. Novos eventos de conexão IPsec serão registrados, bem como notificações enviadas.
 

Quando a opção é FWPM_ENGINE_TXN_WATCHDOG_TIMEOUT_IN_MSEC (disponível apenas no Windows 8 e no Windows Server 2012), newValue deve ser o tempo em milissegundos que especifica a duração máxima para uma única transação WFP. As transações demorando mais do que essa duração dispararão um evento watchdog.

A opção FWPM_ENGINE_NAME_CACHE é reservada para uso interno.

Valor retornado

Tipo: DWORD

Valor/código retornado Descrição
ERROR_SUCCESS
0
 A opção foi definida com êxito.
código de erro FWP_E_*
0x80320001 — 0x80320039
 Um erro específico da Plataforma de Filtragem do Windows (WFP). Consulte Códigos de erro WFP para obter detalhes.
código de erro RPC_*
0x80010001 — 0x80010122
 Falha ao se comunicar com o mecanismo de firewall remoto ou local.

Comentários

Essa função não pode ser chamada de dentro de uma transação. Ele falhará com FWP_E_TXN_IN_PROGRESS. Consulte Gerenciamento de Objetos para obter mais informações sobre transações.

Essa função não pode ser chamada de dentro de uma sessão dinâmica. Ele falhará com FWP_E_DYNAMIC_SESSION_IN_PROGRESS. Consulte Gerenciamento de Objetos para obter mais informações sobre sessões.

O chamador precisa FWPM_ACTRL_WRITE acesso ao mecanismo de filtro. Consulte Controle de Acesso para obter mais informações.

As configurações padrão para a coleção de eventos de rede são as seguintes:

  • Os eventos de saída, todos (unicast, multicast e difusão) são coletados.
  • De entrada, somente eventos unicast são coletados.
As configurações de coleção de eventos de rede persistem entre reinicializações.

Para coletar eventos de rede de transmissão de entrada e/ou multicast,

  1. Chame FwpmEngineSetOption0 com a opção definida como FWPM_ENGINE_COLLECT_NET_EVENTS e newValue definida como 1.
  2. Chame FwpmEngineSetOption0 com a opção definida como FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS e o parâmetro newValue definido como FWPM_NET_EVENT_KEYWORD_INBOUND_MCAST e/ou FWPM_NET_EVENT_KEYWORD_INBOUND_BCAST.
Para interromper a coleta de eventos de rede de transmissão de entrada e/ou multicast,
  • Chame FwpmEngineSetOption0 com a opção definida como FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS e o parâmetro newValue definido como 0 (zero).
Desabilitar e reabilitar a coleção de eventos de rede (FWPM_ENGINE_COLLECT_NET_EVENTS) não redefine a coleção de eventos de transmissão de entrada e multicast.

FwpmEngineSetOption0 é uma implementação específica de FwpmEngineSetOption. Consulte Nomes de Version-Independent WFP e Direcionamento de versões específicas do Windows para obter mais informações.

Requisitos

   
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho fwpmu.h
Biblioteca Fwpuclnt.lib
DLL Fwpuclnt.dll

Confira também

FWPM_ENGINE_OPTION

FWP_VALUE0

FwpmEngineGetOption0