FWPM_FILTER0 structure (fwpmtypes.h)
The FWPM_FILTER0 structure stores the state associated with a filter.
Syntax
typedef struct FWPM_FILTER0_ {
GUID filterKey;
FWPM_DISPLAY_DATA0 displayData;
UINT32 flags;
GUID *providerKey;
FWP_BYTE_BLOB providerData;
GUID layerKey;
GUID subLayerKey;
FWP_VALUE0 weight;
UINT32 numFilterConditions;
FWPM_FILTER_CONDITION0 *filterCondition;
FWPM_ACTION0 action;
union {
UINT64 rawContext;
GUID providerContextKey;
};
GUID *reserved;
UINT64 filterId;
FWP_VALUE0 effectiveWeight;
} FWPM_FILTER0;
Members
filterKey
Uniquely identifies the session.
If the GUID is initialized to zero in the call to FwpmFilterAdd0, the Base Filtering Engine (BFE) will generate one.
displayData
A FWPM_DISPLAY_DATA0 structure that contains human-readable annotations associated with the filter. The name member of the FWPM_DISPLAY_DATA0 structure is required.
flags
A combination of the following values.
providerKey
Optional GUID of the policy provider that manages this filter. See Built-in Provider Identifiers for a list of predefined policy providers.
providerData
A FWP_BYTE_BLOB structure that contains optional provider-specific data used by providers to store additional context information with the object.
layerKey
GUID of the layer where the filter resides. See Filtering Layer Identifiers for a list of possible values.
subLayerKey
GUID of the sub-layer where the filter resides. See Filtering Sub-Layer Identifiers for a list of built-in sub-layers.
If this is set to IID_NULL, the filter is added to the default sublayer.
weight
A FWP_VALUE0 structure that specifies the weight of the filter. The weight indicates the priority of the filter, where higher-numbered weights have higher priorities (and will be evaluated before lower-weighted filters).
Possible type values for weight are as follows.
| **weight** type | Meaning |
|---|---|
|
BFE will use the supplied value as the filter's weight. |
|
BFE will use the supplied value as a weight range index and will compute the filter's weight in that range. See Filter Weight Assignment for more information. |
|
BFE will automatically assign a weight based on the filter conditions. |
See Filter Weight Identifiers for built-in constants that may be used to compute the filter weight.
numFilterConditions
Number of filter conditions.
filterCondition
Array of FWPM_FILTER_CONDITION0 structures that contain all the filtering conditions. All must be true for the action to be performed. In other words, the conditions are evaluated using the AND operator. If no conditions are specified, the action is always performed.
action
A FWPM_ACTION0 structure that specifies the action to be performed if all the filter conditions are true.
rawContext
Available when the filter does not have provider context information, that is, flags does not contain FWPM_FILTER_FLAG_HAS_PROVIDER_CONTEXT. See Filter Context Identifiers for a list of built-in possible values.
The rawContext is placed 'as is' in the context member of the corresponding FWPS_FILTER0 structure, which is documented in the WDK.
providerContextKey
Available when the filter has provider context information, that is, flags contains FWPM_FILTER_FLAG_HAS_PROVIDER_CONTEXT. See Built-in Provider Context Identifiers for a list of predefined policy provider contexts.
The LUID of the provider context specified by the providerContextKey is used to fill in the context member of the corresponding FWPS_FILTER0 structure, which is documented in the WDK.
reserved
Reserved for system use.
filterId
LUID identifying the filter. This is also the LUID of the corresponding FWPS_FILTER0 structure, which is documented in the WDK.
effectiveWeight
An FWP_VALUE0 structure that contains the weight assigned to FWPS_FILTER0, which is documented in the WDK.
Remarks
The first ten members of this structure contain information supplied when adding objects.
The last members, filterId and effectiveWeight, provides additional information when getting/enumerating objects.
FWPM_FILTER0 is a specific implementation of FWPM_FILTER. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Header | fwpmtypes.h |