IFWXConnection::AttachDataFilter method

Article
08/27/2012

Applies to: desktop apps only

The AttachDataFilter method attaches a data filter to the connection.

Syntax

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

Parameters

piDataFilter [in]
Pointer to the IFWXDataFilter interface on the instance of the filter's data filter object to use with the connection.
PriorityClass [in]
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 [in]
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

This method can return one of these values.

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

Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
Header	Wspfwext.idl
DLL	Wspsrv.exe

Share via