AttachDataFilter Method of the IFWXConnection Interface

Article
08/13/2010

The AttachDataFilter method attaches a data filter to the connection.

Syntax

HRESULT AttachDataFilter(
  [in]  IFWXDataFilter* piDataFilter,
  [in]  FwxDataFilterPriorityClass PriorityClass,
  [in]  IUnknown* punkFilterContext
);

Parameters

piDataFilter
Pointer to the IFWXDataFilter interface on the instance of the filter's data filter object to use with the connection.
PriorityClass
Priority class for the data filter. This determines the position of the data filter in relation to other data filters that may be attached to the connection. This parameter is a value from the FwxDataFilterPriorityClass enumeration.
punkFilterContext
Pointer to the interface to use to pass context information to the data filter, such as the session to which the data filter is being attached. This interface is passed to the IFWXDataFilter::SetSockets method in the punkFilterContext parameter. This parameter can be NULL.

Return Value

S_OK
The method succeeded.
E_OUTOFMEMORY
Not enough memory or resources could be allocated to complete the operation.
FWX_E_TERMINATING
The object is shutting down.
E_INVALIDARG
An invalid value was passed to the method.

Remarks

A filter calls this method after it creates an instance of its data filter object.

This method can be called only in the context of the IFWXSessionFilter::FirewallEventHandler method while handling events of types:

fwx_AcceptedConnection

fwx_Bind_Udp

fwx_Connect_Tcp

fwx_Udp_Destination

Requirements

Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
Header	Declared in Wspfwext.idl.
DLL	Requires Wspsrv.exe.