IFWXFilterAdmin::InstallFilter method

Article
08/27/2012

Applies to: desktop apps only

The InstallFilter method registers the filter with Forefront TMG.

Syntax

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
);

Parameters

guidFilter [in]
Class identifier (CLSID) of the COM class that implements the IFWXFilter interface, representing the filter to install.
Name [in]
Pointer to the display name of the filter.
Description [in]
Pointer to the description of the filter.
Vendor [in]
Pointer to the name of the company that wrote the filter.
VersionString [in]
Pointer to a string that specifies the version of the filter.
Reserved [in]
Reserved for future use. The Reserved parameter must be a null pointer.
AssociatedProtocols [in]
The GUIDs of the protocols associated with the filter. The size of this variable is determined by the ProtocolsNumber parameter.
ProtocolsNumber [in]
The number of protocols associated with the filter.

Return value

This method can return one of these values.

S_OK
The filter was installed successfully.
HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS)
The filter is already installed.

Remarks

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.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
Header	Wspfwext.idl
DLL	Wspadmin.dll