Share via

Add Method of the IFPCIpListProviders Interface

  • Article

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

C++

Syntax

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

Parameters

  • Name
    Required. BSTR that specifies the name of the new IP list provider.

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

  • Mask
    Required. BSTR containing a mask that specifies the IP address status codes returned by the new IP list provider that will indicate matched messages.

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

Return Value

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.

Visual Basic

Syntax

Function Add( _
  ByVal Name As String, _
  ByVal FQDN As String, _
  ByVal Mask As String _
) As FPCIpListProvider

Parameters

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

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

  • Mask
    Required. String containing a mask that specifies the IP address status codes returned by the new IP list provider that will indicate matched messages.

Return Value

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

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.

See Also

FPCIpListProviders

Send comments about this topic to Microsoft

Build date: 6/30/2010