Mask Property of the IFPCIpListProvider Interface

Article
08/13/2010

The Mask property gets or sets a mask that specifies the IP address status codes returned by the IP list provider that will indicate matched messages.

C++

HRESULT put_Mask(
    BSTR bstrMask
);
HRESULT get_Mask(
    BSTR* pbstrMask
);

Parameters

bstrMask
BSTR that contains a mask specifying the IP address status codes returned by the IP list provider that will indicate matched messages.
pbstrMask
Pointer to a BSTR that is set on return to a string value containing a mask specifying the IP address status codes returned by the IP list provider that will indicate matched messages.

Return Value

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Visual Basic

Property Mask As String

Property Value

String that contains a mask specifying the IP address status codes returned by the IP list provider that will indicate matched messages.

Remarks

This property is read/write. Its value is initially set when the object is created using the Add method of the FPCIpListProviders collection (IFPCIpListProviders interface in C++).

This property is ignored when the MatchAnyReturnCode property is set to True (VARIANT_TRUE in C++).

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.

Share via