Enabled Property of the IFPCWebFilter Interface

Article
08/13/2010

The Enabled property gets or sets a Boolean value that indicates whether the Web filter is enabled.

C++

HRESULT put_Enabled(
    VARIANT_BOOL fEnabled
);
HRESULT get_Enabled(
    VARIANT_BOOL* pfEnabled
);

Parameters

fEnabled
Boolean value that indicates whether the Web filter is enabled.
pfEnabled
Pointer to a Boolean variable that is set on return to VARIANT_TRUE if the Web filter is enabled, or to VARIANT_FALSE if the Web filter is disabled.

Return Value

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

Visual Basic

Property Enabled As Boolean

Property Value

Boolean value that indicates whether the Web filter is enabled.

Example Code

This VBScript subprocedure receives the GUID of a Web filter and enables or disables the Web filter by setting the Enabled property to True or False according to the value of the second argument passed to it. It does not include error handling.

Sub EnableDisableWebFilter(filterGuid, NewValue)
    ' Declare the other objects needed.
    Dim root           ' The FPCLib.FPC root object
    Dim tmgArray       ' An FPCArray object
    Dim filter         ' An FPCWebFilter object
    Dim currentValue   ' A Boolean
    ' Create the root object.
    Set root = CreateObject("FPC.Root")
    ' Get references to the array object 
    ' and the Web filter object.
    Set tmgArray = root.GetContainingArray()
    Set filter = tmgArray.Extensions.WebFilters.Item(filterGuid)
    ' Change the value of the property if necessary.
    currentValue = filter.Enabled
    WScript.Echo "Current value of Enabled for " & filter.Name & ": " & currentValue
    If newValue <> currentValue Then
        filter.Enabled = newValue
        WScript.Echo "Changing the Enabled property to " & filter.Enabled
        filter.Save
        WScript.Echo "Done!" 
    End If
End Sub

Remarks

This property is read/write.

When an enterprise with central array management is deployed, Web filters can be registered in the enterprise configuration and in an array configuration. If a Web filter is enabled in the enterprise configuration, the enterprise setting is applied to each array, and the filter cannot be disabled in an array configuration. If a Web filter is disabled in the enterprise configuration, it can be enabled or disabled in an array configuration.

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.