Compartilhar via


Função FwpmEngineGetOption0 (fwpmk.h)

A função FwpmEngineGetOption0 recupera uma opção de mecanismo de filtro.

Sintaxe

NTSTATUS FwpmEngineGetOption0(
  [in]  HANDLE             engineHandle,
  [in]  FWPM_ENGINE_OPTION option,
  [out] FWP_VALUE0         **value
);

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 recuperada.

[out] value

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

Se a opção for FWPM_ENGINE_COLLECT_NET_EVENTS, o valor será um dos seguintes.

Valor Significado
0 Eventos de rede não estão sendo coletados.
1 Eventos de rede estão sendo coletados.

Se opção for FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS, valor será uma combinação bit a bit dos valores a seguir.

Valor Significado
FWPM_NET_EVENT_KEYWORD_INBOUND_MCAST (1) Eventos de rede multicast de entrada estão sendo coletados.
FWPM_NET_EVENT_KEYWORD_INBOUND_BCAST (2) Eventos de rede de transmissão de entrada não estão sendo coletados.

Se opção estiver FWPM_ENGINE_PACKET_QUEUING (disponível somente no Windows 8 e no Windows Server 2012), valor será um dos seguintes.

Valor Significado
FWPM_ENGINE_OPTION_PACKET_QUEUE_NONE (0) Nenhuma fila de pacotes está habilitada.
FWPM_ENGINE_OPTION_PACKET_QUEUE_INBOUND (1) A fila de pacotes de entrada está habilitada.
FWPM_ENGINE_OPTION_PACKET_QUEUE_OUTBOUND (2) A fila de pacotes de saída está habilitada.

Se opção estiver FWPM_ENGINE_MONITOR_IPSEC_CONNECTIONS (disponível somente no Windows 8 e no Windows Server 2012), valor será um dos seguintes.

Valor Significado
0 O recurso monitoramento de conexão IPsec está desabilitado. Nenhum evento de conexão IPsec ou notificações estão sendo registrados.
1 O recurso de Monitoramento de Conexão IPsec está habilitado. Novos eventos e notificações de conexão IPsec estão sendo registrados em log.

Se opção estiver FWPM_ENGINE_TXN_WATCHDOG_TIMEOUT_IN_MSEC (disponível somente no Windows 8 e no Windows Server 2012), valor 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 A opção foi recuperada com êxito.
0x80320001 de código de erro FWP_E_* — 0x80320039 Um erro específico da Plataforma de Filtragem do Windows (WFP). Consulte de códigos de erro do WFP para obter detalhes.
0x80010001 de código de erro RPC_*— 0x80010122 Falha ao se comunicar com o mecanismo de firewall local ou remoto.
outros códigos NTSTATUS Ocorreu um erro.

Observações

O chamador deve liberar o objeto retornado por uma chamada para FwpmFreeMemory0.

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

FwpmEngineGetOption0 é uma implementação específica do FwpmEngineGetOption. 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