Add Method of the IFPCBlockedSenders Interface

  • Article

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

C++

Syntax

HRESULT Add(
  [in]   BSTR Address,
  [in]   FpcBlockedSenderAddressType AddressType,
  [out]  IFPCBlockedSender** ppNewItem
);

Parameters

  • Address
    Required. BSTR that specifies the e-mail address of a single blocked sender or the domain name of the blocked senders.

  • AddressType
    Required. Value from the FpcBlockedSenderAddressType enumerated type that indicates whether the new object represents a single blocked sender, all senders from the specified domain, or all senders from the specified domain and all of its subdomains.

  • ppNewItem
    Address of an interface pointer that on return points to the new IFPCBlockedSender 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 Address As String, _
  ByVal AddressType As FpcBlockedSenderAddressType _
) As FPCBlockedSender

Parameters

  • Address
    Required. String that specifies the e-mail address of a single blocked sender or the domain name of the blocked senders.

  • AddressType
    Required. Value from the FpcBlockedSenderAddressType enumerated type that indicates whether the new object represents a single blocked sender, all senders from the specified domain, or all senders from the specified domain and all of its subdomains.

Return Value

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

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

FPCBlockedSenders

Send comments about this topic to Microsoft

Build date: 6/30/2010