IFPCIpListProviders::Add method

Article
08/27/2012

Applies to: desktop apps only

The Add method creates a new FPCIpListProvider object in the collection and returns a reference to it.

Syntax

HRESULT Add(
  [in]   BSTR Name,
  [in]   String Name,
  [in]   BSTR FQDN,
  [in]   String FQDN,
  [in]   BSTR Mask,
  [in]   String Mask,
  [out]  IFPCIpListProvider **ppNewItem
);

FPCIpListProviders.Add( _
  ByVal Name As BSTR, _
  ByVal Name As String, _
  ByVal FQDN As BSTR, _
  ByVal FQDN As String, _
  ByVal Mask As BSTR, _
  ByVal Mask As String, _
  ByRef ppNewItem As IFPCIpListProvider _
) As FPCIpListProvider

Parameters

Name [in]

C++
Required. BSTR that specifies the name of the new IP list provider.

VB
Required. String that specifies the name of the new IP list provider.

FQDN [in]

C++	Required. BSTR that specifies the fully qualified domain name (FQDN) for sending queries to the new IP list provider.
VB	Required. String that specifies the fully qualified domain name (FQDN) for sending queries to the new IP list provider.

Mask [in]

C++	Required. BSTR containing a mask that specifies the IP address status codes returned by the new IP list provider that will indicate matched messages.
VB	Required. String containing a mask that specifies the IP address status codes returned by the new IP list provider that will indicate matched messages.

ppNewItem [out]
Address of an interface pointer that on return points to the new IFPCIpListProvider interface created.

Return value

C++

This method can return one of the following:

S_OK, indicating that the operation succeeded.
An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

VB

This method returns a reference to the FPCIpListProvider object if successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

The expression specified in the Mask parameter must have the form 127.0.0.x, where x is a bitmask that may include any of the following values.

1—The IP address is on the IP Allow list or IP Block list.
2—The SMTP server is configured to act as an open relay.
4—The IP address supports a dial-up IP address.

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll