IFPCWebFilter::Enabled property

Article
08/27/2012

Applies to: desktop apps only

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

This property is read/write.

Syntax

HRESULT put_Enabled(
  VARIANT_BOOL fEnabled
);

HRESULT get_Enabled(
  VARIANT_BOOL *pfEnabled
);

' Data type: Boolean

Property Enabled( _
  ByVal fEnabled As VARIANT_BOOL, _
  ByVal pfEnabled As VARIANT_BOOL _
) As Boolean

Property value

Boolean value that indicates whether the Web filter is enabled.

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.

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.

Examples

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

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