SF_REQ_DISABLE_WPX_NOTIFICATIONS callback function

Article
08/27/2012

Applies to: desktop apps only

The SF_REQ_DISABLE_WPX_NOTIFICATIONS form of the WPXSupportFunction callback function can be used to disable types of event notifications that are specific to Forefront TMG for your Web filter for the remaining lifetime of the current request. If a particular event notification is disabled for your filter, the Forefront TMG Web proxy will not call your filter when the applicable event occurs.

This function does not affect new requests, even in the same session.

Syntax

BOOL WINAPI * WPXSupportFunction(
  _In_  struct _HTTP_FILTER_CONTEXT *pfc,
  _In_  enum SF_WPX_REQ_TYPE sfReq,
  PVOID pData,
  _In_  DWORD ul1,
  DWORD ul2
);

Parameters

pfc [in]
Pointer to the HTTP_FILTER_CONTEXT data structure that is associated with the current, active HTTP session. Pass the filter context in this parameter.
sfReq [in]
Specifies the particular support function that is to be executed by the ISA Web filter, in this case, SF_REQ_DISABLE_WPX_NOTIFICATIONS.
pData
Unused in this support function.
ul1 [in]
Bitmask containing flags that specify the types of event notifications which are to be disabled. The possible flags are listed in the Remarks section.
ul2
Unused in this support function.

Return value

This callback function returns TRUE if the call is successful; otherwise, it returns FALSE. To obtain extended error information, call GetLastError.

Remarks

This callback function can disable the following event notifications:

SF_NOTIFY_FORWARD_RAW_DATA
SF_NOTIFY_FORWARD_RAW_DATA_COMPLETED
SF_NOTIFY_POLICY_CHECK_COMPLETED
SF_NOTIFY_RECEIVE_RESPONSE_HEADERS
SF_NOTIFY_RECEIVE_RESPONSE_RAW_DATA
SF_NOTIFY_ROUTING

This callback function can disable only the event notifications that are specific to Forefront TMG. The general event notifications that are not specific to Forefront TMG can be disabled by the SF_REQ_DISABLE_NOTIFICATIONS form of the ServerSupportFunction callback function. For more information about the types of event notifications that are sent to Web filters, see Event Notifications.

The WPXSupportFunction function is called through a pointer that is a member of the WPX_FILTER_CONTEXT structure. To get a pointer to the WPX_FILTER_CONTEXT structure for calling the WPXSupportFunction function, use the TO_WPX_FILTER_CONTEXT macro as follows:

WPX_FILTER_CONTEXT* pwfc = TO_WPX_FILTER_CONTEXT(pfc);
if (pwfc != NULL) {
...
}

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	Wpxhttpfilt.h