FwpmEngineGetOption0 函数 (fwpmk.h)
FwpmEngineGetOption0 函数检索筛选器引擎选项。
语法
NTSTATUS FwpmEngineGetOption0(
[in] HANDLE engineHandle,
[in] FWPM_ENGINE_OPTION option,
[out] FWP_VALUE0 **value
);
参数
[in] engineHandle
筛选引擎打开的会话句柄。 调用 FwpmEngineOpen0 以打开筛选器引擎的会话。
[in] option
要检索的选项。
[out] value
选项值。 值参数中包含的数据类型将 FWP_UINT32。
如果选项是 FWPM_ENGINE_COLLECT_NET_EVENTS,则值将是下列值之一。
价值 | 意义 |
---|---|
0 | 未收集网络事件。 |
1 | 正在收集网络事件。 |
如果 FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS选项,则 值 将是以下值的按位组合。
价值 | 意义 |
---|---|
FWPM_NET_EVENT_KEYWORD_INBOUND_MCAST (1) | 正在收集入站多播网络事件。 |
FWPM_NET_EVENT_KEYWORD_INBOUND_BCAST (2) | 未收集入站广播网络事件。 |
如果 选项FWPM_ENGINE_PACKET_QUEUING(仅在 Windows 8 和 Windows Server 2012 中可用),值 将是以下值之一。
价值 | 意义 |
---|---|
FWPM_ENGINE_OPTION_PACKET_QUEUE_NONE (0) | 未启用数据包队列。 |
FWPM_ENGINE_OPTION_PACKET_QUEUE_INBOUND (1) | 已启用入站数据包队列。 |
FWPM_ENGINE_OPTION_PACKET_QUEUE_OUTBOUND (2) | 已启用出站数据包队列。 |
如果 选项FWPM_ENGINE_MONITOR_IPSEC_CONNECTIONS(仅在 Windows 8 和 Windows Server 2012 中可用),值 将是下列值之一。
价值 | 意义 |
---|---|
0 | IPsec 连接监视功能已禁用。 未记录任何 IPsec 连接事件或通知。 |
1 | 已启用 IPsec 连接监视功能。 正在记录新的 IPsec 连接事件和通知。 |
如果 选项FWPM_ENGINE_TXN_WATCHDOG_TIMEOUT_IN_MSEC(仅在 Windows 8 和 Windows Server 2012 中可用),值 将是指定单个 WFP 事务的最大持续时间的时间(以毫秒为单位)。 超过此持续时间的事务将触发监视程序事件。
FWPM_ENGINE_NAME_CACHE 选项保留供内部使用。
返回值
返回代码/值 | 描述 |
---|---|
ERROR_SUCCESS 0 | 已成功检索该选项。 |
FWP_E_* 错误代码 0x80320001 - 0x80320039 | Windows 筛选平台(WFP)特定错误。 有关详细信息,请参阅 WFP 错误代码。 |
RPC_* 错误代码 0x80010001 - 0x80010122 | 无法与远程或本地防火墙引擎通信。 |
其他 NTSTATUS 代码 | 发生错误。 |
言论
调用方必须通过调用 FwpmFreeMemory0释放返回的对象。
调用方需要 FWPM_ACTRL_READ 筛选器引擎的访问权限。 有关详细信息,请参阅 访问控制。
FwpmEngineGetOption0 是 FwpmEngineGetOption 的特定实现。 有关详细信息,请参阅 WFP Version-Independent 名称和面向特定版本的 Windows。
要求
要求 | 价值 |
---|---|
最低支持的客户端 | 从 Windows Vista 开始可用。 |
目标平台 | 普遍 |
标头 | fwpmk.h |
库 | fwpkclnt.lib |
IRQL | <= PASSIVE_LEVEL |