Remove Method of the IFPCWebFilters Interface
The Remove method removes the specified FPCWebFilter object from the collection.
C++
Syntax
HRESULT Remove(
[in] VARIANT Index
);
Parameters
- Index
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
This method returns S_OK if the call is successful; otherwise, it returns an error code.
Visual Basic
Syntax
Sub Remove( _
ByVal Index As Variant _
)
Parameters
- Index
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
This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.
Example Code
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
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.
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. |
See Also
Send comments about this topic to Microsoft
Build date: 6/30/2010