IFPCSmtpRoutes::Add method

  • Article

Applies to: desktop apps only

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

Syntax

HRESULT Add(
  [in]   BSTR Name,
  [in]   String Name,
  [out]  IFPCSmtpRoute **ppNewItem
);

FPCSmtpRoutes.Add( _
  ByVal Name As BSTR, _
  ByVal Name As String, _
  ByRef ppNewItem As IFPCSmtpRoute _
) As FPCSmtpRoute

Parameters

  • Name [in]

    C++

    Required. BSTR that specifies the name of the new SMTP route.
    VB

    Required. String that specifies the name of the new SMTP route.

  • ppNewItem [out]
    Address of an interface pointer that on return points to the new IFPCSmtpRoute 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 an FPCSmtpRoute object if successful. Otherwise, an error is raised that can be intercepted by using an error handler.

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

See also

FPCSmtpRoutes

 

 

Build date: 7/12/2010