IFPCPathMappings::Add method

  • Article

Applies to: desktop apps only

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

Syntax

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

FPCPathMappings.Add( _
  ByVal InternalPath As String, _
  ByVal SameAsInternal As Boolean, _
  ByVal ExternalPath As String, _
  ByRef ppNewItem As IFPCPathMapping _
) As FPCPathMapping

Parameters

  • InternalPath [in]

    C++ BSTR that specifies the internal path.
    VB String that specifies the internal path.

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

  • ExternalPath [in]

    C++ BSTR that specifies the external path. This parameter is ignored if the SameAsInternal parameter is set to VARIANT_TRUE.
    VB String that specifies the external path. This parameter is ignored if the SameAsInternal parameter is set to True.

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

FPCPathMappings

 

 

Build date: 7/12/2010