Compartilhar via

Função FwpmEngineSetOption0 (fwpmk.h)

  • Artigo

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

Sintaxe

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

Parâmetros

[in] engineHandle

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

[in] option

A opção a ser definida.

[in] newValue

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

Quando 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 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 opção é FWPM_ENGINE_PACKET_QUEUING (disponível somente 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 opção é FWPM_ENGINE_MONITOR_IPSEC_CONNECTIONS (disponível somente 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á-la.)

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

Quando opção é FWPM_ENGINE_TXN_WATCHDOG_TIMEOUT_IN_MSEC (disponível somente 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. 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 de retorno

Código/valor de retorno Descrição
ERROR_SUCCESS
0		 Êxito
FWP_E_* código de erro
0x80320001 — 0x80320039		 Um erro específico da Plataforma de Filtragem do Windows (WFP). Consulte de códigos de erro do WFP para obter detalhes.
código de erro RPC_*
0x80010001 — 0x80010122		 Falha ao se comunicar com o mecanismo de firewall local ou remoto.
outros códigos NTSTATUS Ocorreu um erro.

Observações

Essa função não pode ser chamada de dentro de uma transação, ela falha com FWP_E_TXN_IN_PROGRESS. Consulte de 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, ela falha com FWP_E_DYNAMIC_SESSION_IN_PROGRESS. Consulte de Gerenciamento de Objetos para obter mais informações sobre sessões.

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

As configurações padrão da 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 opção definida como FWPM_ENGINE_COLLECT_NET_EVENTS e newValue definido como 1.
  2. Chame FwpmEngineSetOption0 com a opção definida como FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS e novo parâmetro Value definido como FWPM_NET_EVENT_KEYWORD_INBOUND_MCAST e/ou FWPM_NET_EVENT_KEYWORD_INBOUND_BCAST.

Para parar de coletar 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 novo parâmetro de doValue 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 do FwpmEngineSetOption. Consulte nomes de Version-Independent WFP e versões específicas de destino do Windows para obter mais informações.

Requisitos

Requisito Valor
de cliente com suporte mínimo Disponível a partir do Windows Vista.
da Plataforma de Destino Universal
cabeçalho fwpmk.h
biblioteca fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

Consulte também