IsIncluded Method of the IFWXIpFilter Interface

Article
08/13/2010

The IsIncluded method checks if a particular IP address is included in the ranges of those allowed by the IP filter.

Syntax

HRESULT IsIncluded(
    IN_ADDR IP
);

Parameters

IP
IP address to check.

Return Value

S_OK
The address is included.
S_FALSE
The address is not included.

Remarks

Based on the value returned by the IFWXIpFilter::IsIncluded method, you can decide whether to initiate a connection. There is no automatic effect upon the connection. For example, you may use this method in the following way:

Call the IFWXConnection::GetIpFilter method on a connection object, such as a listening connection object.
Use the IFWXIpFilter::IsIncluded method to check if a specific IP address is included in the ranges specified by the filter.
If the address is not included in the range, you can decide not to initiate the connection.

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.