IFWXIpFilter::IsIncluded method

Article
08/27/2012

Applies to: desktop apps only

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

This method can return one of these values.

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

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