IFWXFilterAdmin::InstallFilter

The InstallFilter method registers the filter with ISA Server.

HRESULT InstallFilter(
  REFCLSID guidFilter,
  LPCSTR Name,
  LPCSTR Description,
  LPCSTR Vendor,
  LPCSTR VersionString,
  LPCSTR Reserved,
  GUID AssociatedProtocols,
  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 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 ISA Server Management, and are not parsed or interpreted by the service.

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Wspfwext.idl.

See Also

IFWXFilterAdmin