FWPS_INCOMING_METADATA_VALUES0 structure [Filtering]

  • Article

The FWPS_INCOMING_METADATA_VALUES0 structure provides additional meta-information to the filter engine.

typedef struct FWPS_INCOMING_CONTEXT_VALUES0_ {
  UINT32 currentMetadataValues;
  UINT32 flags;
  UINT64 reserved;
  FWPS_DISCARD_METADATA0 discardMetadata;
  UINT64 flowHandle;
  UINT32 ipHeaderSize;
  UINT32 transportHeaderSize;
  FWP_BYTE_BLOB* processPath;
  UINT64 token;
  UINT64 processId;
  UINT32 sourceInterfaceIndex;
  UINT32 destinationInterfaceIndex;
  ULONG compartmentId;
  FWPS_INBOUND_FRAGMENT_METADATA0 fragmentMetadata;
  ULONG pathMtu;
  HANDLE completionHandle;
} FWPS_INCOMING_METADATA_VALUES0;

Members

  • currentMetadataValues
    Settings used to specify which values are present in this structure.

    Possible values.

    Value Meaning
    FWPS_METADATA_FIELD_DISCARD_REASON Indicates a discard reason.
    FWPS_METADATA_FIELD_FLOW_HANDLE Indicates a flow handle.
    FWPS_METADATA_FIELD_IP_HEADER_SIZE Indicates an IP header size.
    FWPS_METADATA_FIELD_PROCESS_PATH Indicates a process path.
    FWPS_METADATA_FIELD_TOKEN Indicates a token.
    FWPS_METADATA_FIELD_PROCESS_ID Indicates a process identifier.
    FWPS_METADATA_FIELD_SYSTEM_FLAGS Indicates a set of system flags.
    FWPS_METADATA_FIELD_RESERVED Indicates a reserved field.
    FWPS_METADATA_FIELD_SOURCE_INTERFACE_INDEX Indicates a source interface index.
    FWPS_METADATA_FIELD_DESTINATION_INTERFACE_INDEX Indicates a destination interface index.
    FWPS_METADATA_FIELD_TRANSPORT_HEADER_SIZE Indicates a transport header size.
    FWPS_METADATA_FIELD_COMPARTMENT_ID Indicates a compartment ID.
    FWPS_METADATA_FIELD_FRAGMENT_DATA Indicates field fragment data.
    FWPS_METADATA_FIELD_PATH_MTU Indicates a path's maximum transmition unit.
    FWPS_METADATA_FIELD_COMPLETION_HANDLE Indicates a completion handle.
    FWPS_METADATA_FIELD_TRANSPORT_ENDPOINT_HANDLE Indicates a transport endpoint handle.
    FWPS_METADATA_FIELD_TRANSPORT_CONTROL_DATA Indicates a transport control data.
    FWPS_METADATA_FIELD_REMOTE_SCOPE_ID Indicates a remote scope identifier.
    FWPS_METADATA_FIELD_PACKET_DIRECTION Indicates a packet direction.
    FWPS_METADATA_FIELD_PACKET_SYSTEM_CRITICAL Indicates a system critical packet.
    Note  Requires Windows Vista SP1
    FWPS_METADATA_FIELD_FORWARD_LAYER_OUTBOUND_PASS_THRU Indicates a forward layer outbound pass-through.
    Note  Requires Windows Vista SP1
    FWPS_METADATA_FIELD_FORWARD_LAYER_INBOUND_PASS_THRU Indicates a forward layer inbound pass-through.
    Note  Requires Windows Vista SP1

  • flags
    Possible values.

    FWPS_INCOMING_FLAG_CACHE_SAFE
    FWPS_INCOMING_FLAG_ENFORCE_QUERY
    FWPS_INCOMING_FLAG_ABSORB
    FWPS_INCOMING_FLAG_CONNECTION_FAILING_INDICATION

  • reserved
    Reserved for system use only.

  • discardMetadata
    Structure containing the discard module and reason.

    See FWPS_DISCARD_METADATA0 for more information.

  • flowHandle
    Flow Handle.

  • ipHeaderSize
    IP Header size.

  • transportHeaderSize
    Transport Header size.

  • processPath
    Pointer to a FWP_BYTE_BLOB containing the process path.

  • token
    Token used for authorization.

  • processId
    Process Id.

  • sourceInterfaceIndex
    Source interface index for discard indications.

  • destinationInterfaceIndex
    Destination interface index for discard indications.

  • compartmentId
    Compartment identifier for injection APIs.

  • fragmentMetadata
    A FWPS_INBOUND_FRAGMENT_METADATA0 structure that contains fragment data for inbound packets.

  • pathMtu
    Path MTU for outbound packets.

  • completionHandle
    Completion handle.

Remarks

This information is not processed by the filter engine, but is supplied to the callouts.

Requirements

Client Requires Windows Vista.
Server Requires Windows Server "Longhorn".
Header

Declared in Fwpsu.h.

See Also

Windows Filtering Platform API Structures
FWPS_INCOMING_VALUES0