IFPCWebFilter::RelativePath property

Article
08/27/2012

Applies to: desktop apps only

The RelativePath property gets or sets the path to the dynamic-link library (DLL) for the Web filter, including the file name of the DLL, relative to the Forefront TMG installation folder.

This property is read/write.

Syntax

HRESULT put_RelativePath(
  BSTR bstrPath
);

HRESULT get_RelativePath(
  BSTR *pbstrPath
);

' Data type: String

Property RelativePath( _
  ByVal bstrPath As BSTR, _
  ByVal pbstrPath As BSTR _
) As String

Property value

String that specifies the relative path of the filter's DLL.

Error codes

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Remarks

This property is read/write. It is initially set when the object is created by a call to the Add method of the FPCWebFilters collection (IFPCWebFilters interface in C++).

For a Web filter to work on a Forefront TMG computer, its dynamic-link library (DLL) must be copied to the computer, an object representing it must be created in the FPCWebFilters collection for the computer's array, and it must be registered as an extension of the Forefront TMG Web proxy on the computer by including a reference to it in the computer's InstalledWebFilters property.

When an enterprise with central array management is deployed, Web filters can be added to the FPCWebFilters collections in the enterprise configuration and in array configurations. If the same Web filter is included in the FPCWebFilters collections in the enterprise configuration and an array configuration with different values for the FilterDirection property of the Web filter, the enterprise setting overrides the array setting. Conversely, the values of the RelativePath and Priority properties in the enterprise configuration are ignored.

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