IFPCStaticRoutes::Add method

  • Article

Applies to: desktop apps only

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

Syntax

HRESULT Add(
  [in]   BSTR Destination,
  [in]   String Destination,
  [in]   BSTR Subnet,
  [in]   String Subnet,
  [in]   BSTR AdapterName,
  [in]   String AdapterName,
  [in]   BSTR Gateway,
  [in]   String Gateway,
  [out]  IFPCStaticRoute **ppStaticRoute
);

FPCStaticRoutes.Add( _
  ByVal Destination As BSTR, _
  ByVal Destination As String, _
  ByVal Subnet As BSTR, _
  ByVal Subnet As String, _
  ByVal AdapterName As BSTR, _
  ByVal AdapterName As String, _
  ByVal Gateway As BSTR, _
  ByVal Gateway As String, _
  ByRef ppStaticRoute As IFPCStaticRoute _
) As FPCStaticRoute

Parameters

  • Destination [in]

    C++

    Required. BSTR that specifies the IP address of the destination of the new static route.
    VB

    Required. String that specifies the IP address of the destination of the new static route.

  • Subnet [in]

    C++

    Required. BSTR that specifies the subnet mask of the destination of the new static route.
    VB

    Required. String that specifies the subnet mask of the destination of the new static route.

  • AdapterName [in]

    C++

    Required. BSTR that specifies the name of the network adapter associated with the new static route.
    VB

    Required. String that specifies the name of the network adapter associated with the new static route.

  • Gateway [in]

    C++

    Required. BSTR that specifies the gateway for the new static route.
    VB

    Required. String that specifies the gateway for the new static route.

  • ppStaticRoute [out]
    Address of an interface pointer that on return points to the new IFPCStaticRoute 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 FPCStaticRoute 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

FPCStaticRoutes

 

 

Build date: 7/12/2010