Add Method of the IFPCPathMappings Interface

  • Article

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

C++

Syntax

HRESULT Add(
  [in]   BSTR InternalPath,
  [in]   VARIANT_BOOL SameAsInternal,
  [in]   BSTR ExternalPath,
  [out]  IFPCPathMapping** ppNewItem
);

Parameters

  • InternalPath
    BSTR that specifies the internal path.

  • SameAsInternal
    Boolean value that specifies whether the external path is the same as the internal path.

  • ExternalPath
    BSTR that specifies the external path. This parameter is ignored if the SameAsInternal parameter is set to VARIANT_TRUE.

  • ppNewItem
    Address of an interface pointer that on return points to the new IFPCPathMapping 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 InternalPath As String, _
  ByVal SameAsInternal As Boolean, _
  ByVal ExternalPath As String _
) As FPCPathMapping

Parameters

  • InternalPath
    String that specifies the internal path.

  • SameAsInternal
    Boolean value that specifies whether the external path is the same as the internal path.

  • ExternalPath
    String that specifies the external path. This parameter is ignored if the SameAsInternal parameter is set to True.

Return Value

This method returns a reference to the new FPCPathMapping object 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

FPCPathMappings

Send comments about this topic to Microsoft

Build date: 6/30/2010