HTTP_FILTER_VERSION structure

  • Article

Applies to: desktop apps only

The HTTP_FILTER_VERSION structure is used by the GetFilterVersion and GetWPXFilterVersion entry-point functions to set the filter version information and to specify the types of event notifications which are to be sent to a Web filter.

Syntax

typedef struct _HTTP_FILTER_VERSION {
  DWORD dwServerFilterVersion;
  DWORD dwFilterVersion;
  CHAR  lpszFilterDesc[SF_MAX_FILTER_DESC_LEN];
  DWORD dwFlags;
} HTTP_FILTER_VERSION, *PHTTP_FILTER_VERSION;

Members

  • dwServerFilterVersion
    The version number of the Web filter API used by the Forefront TMG computer. Set by the Forefront TMG Web proxy.

  • dwFilterVersion
    The version number of the Web filter API used by the Web filter. Set by the Web filter. The version used by your filter can be set to WPX_HTTP_FILTER_REVISION definition, which is defined in the Wpxhttpfilt.h header file.

    The filter version is required. If the filter version number is higher than the version number of the Web filter API used by the Forefront TMG computer in the dwServerFilterVersion parameter, the filter will not be loaded to avoid version issues.

  • lpszFilterDesc
    Not used in Forefront TMG.

  • dwFlags
    Bitmask containing flags that specify the types of event notifications which are to be sent to the Web filter and the port security of connections for which event notifications are sent. This bitmask is set by the Web filter. For a complete list of the possible flags and descriptions of the event notifications that they specify, see Event Notifications.

    Note  The SF_NOTIFY_ORDER_DEFAULT, SF_NOTIFY_ORDER_LOW, SF_NOTIFY_ORDER_MEDIUM, and SF_NOTIFY_ORDER_HIGH flags should not be included in this parameter. These flags are used in ISAPI extensions (filters) to set the filter priority. For a Web filter, the priority is specified by the Priority property of the FPCWebFilter object that represents the filter. This property is initially set in the call to the Add method of the FPCWebFilters collection that creates the FPCWebFilter object in the filter registration code.

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

 Httpfilt.h

See also

Notification Structures

 

 

Build date: 7/12/2010