InstallFilter Method of the IFWXFilterAdmin Interface

The InstallFilter method registers the filter with Forefront TMG.


HRESULT InstallFilter(
  [in]  REFCLSID guidFilter,
  [in]  LPCSTR Name,
  [in]  LPCSTR Description,
  [in]  LPCSTR Vendor,
  [in]  LPCSTR VersionString,
  [in]  LPCSTR Reserved,
  [in]  GUID AssociatedProtocols,
  [in]  UINT ProtocolsNumber


  • guidFilter
    Class identifier (CLSID) of the COM class that implements the IFWXFilter interface, representing the filter to install.

  • Name
    Pointer to the display name of the filter.

  • Description
    Pointer to the description of the filter.

  • Vendor
    Pointer to the name of the company that wrote the filter.

  • VersionString
    Pointer to a string that specifies the version of the filter.

  • Reserved
    Reserved for future use. The Reserved parameter must be a null pointer.

  • AssociatedProtocols
    The GUIDs of the protocols associated with the filter. The size of this variable is determined by the ProtocolsNumber parameter.

  • ProtocolsNumber
    The number of protocols associated with the filter.

Return Value

  • S_OK
    The filter was installed successfully.

    The filter is already installed.


The Microsoft Firewall service uses the CLSID of the filter when loading it. The name, description, vendor, and version string are used for displaying information about the filter in Forefront TMG Management, and are not parsed or interpreted by the service.

This method is supported only for backward compatibility. For information about how to register an application filter, see Filter Setup.


Server Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version Requires Forefront Threat Management Gateway (TMG) 2010.

Declared in Wspfwext.idl.


Requires Wspadmin.dll.

See Also


Send comments about this topic to Microsoft

Build date: 6/30/2010