IFPCWebFilters::Remove method

Article
08/27/2012

Applies to: desktop apps only

The Remove method removes the specified FPCWebFilter object from the collection.

Syntax

HRESULT Remove(
  [in]  VARIANT Index
);

FPCWebFilters.Remove( _
  ByVal Index As Variant _
)

Parameters

Index [in]
Required. String-formatted globally unique identifier (GUID) of the Web filter represented by the FPCWebFilter object to remove, or one-based index of the object to remove.

Return value

C++

This method returns S_OK if the call is successful; otherwise, it returns an error code.

VB

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Remarks

When the Remove method is called to unregister a Web filter in an array, the reference to the FPCWebFilter object representing the Web filter is automatically removed from the FPCRefs collection stored in the InstalledWebFilters property of the local Forefront TMG computer.

Examples

This VBScript subprocedure deletes the Web filter having the GUID passed to it. It does not include error handling.

Sub DeleteWebFilter(filterGuid)
    ' Declare the other objects needed.
    Dim root           ' The FPCLib.FPC root object
    Dim tmgArray       ' An FPCArray object
    Dim filters        ' An FPCWebFilter collection
    ' 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 filters = tmgArray.Extensions.WebFilters
    ' Delete the specified filter.
    WScript.Echo "Deleting the " & filters(filterGuid).Name & " Web filter..." 
    filters.Remove(filterGuid)
    filters.Save
    WScript.Echo "Done!" 
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