IFWXFilterAdmin::InstallFilter Method

Registers the filter with ISA Server.

HRESULT InstallFilter(
  REFCLSID guidFilter,
  LPCSTR Name,
  LPCSTR Description,
  LPCSTR Vendor,
  LPCSTR VersionString,
  LPCSTR Reserved,
  FwxScope Scope
);

Parameters

guidFilter

[in] CLSID of the IFWXFilter object to install.

Name

[in] Pointer to the short 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 representation for the version of the filter.

Reserved

[in] Reserved for future use. Passes a null pointer.

Scope

[in] The scope of the filter object, either array or enterprise, as a value from the FwxScope enumerated type. This parameter cannot be set to fwx_EnterpriseScope for a stand-alone server or for ISA Server Standard Edition.

Return Values

S_OK

The filter was installed successfully.

HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS)

The filter is already installed.

Remarks

The 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 Management, and are not parsed or interpreted by the proxy.

On an array, InstallFilter should be called for each array member. ISA keeps track of application filter installation for each server and will alert users if a filter is installed on some, but not all array members.