HTTP_FILTER_SEND_RESPONSE structure

  • Article

Applies to: desktop apps only

The Forefront TMG Web proxy includes a pointer to the HTTP_FILTER_SEND_RESPONSE structure in the notification that it sends to Web filters when Forefront TMG sends headers to the client. A filter can inspect, modify, or add headers that the client will receive as part of the response to the client's original request. The structure contains the same members as HTTP_FILTER_PREPROC_HEADERS. If your filter should be notified for this event, it must register to receive SF_NOTIFY_SEND_RESPONSE notifications. For more information about the types of event notifications that are sent to Web filters, see Event Notifications.

Note  An SF_NOTIFY_SEND_RESPONSE notification is not sent when Forefront TMG returns a response from a Web site or from the cache. However, it is sent when Forefront TMG creates a response, such as an error page, or when a filter generates a response by using SF_REQ_SEND_RESPONSE_HEADER.

Syntax

typedef struct HTTP_FILTER_SEND_RESPONSE {
  BOOL (WINAPI) *GetHeader;
  BOOL (WINAPI) *SetHeader;
  BOOL (WINAPI) *AddHeader;
  DWORD         HttpStatus;
  DWORD         dwReserved;
} HTTP_FILTER_SEND_RESPONSE, *PHTTP_FILTER_SEND_RESPONSE;

Members

  • GetHeader
    Pointer to the GetHeader function, which can be used to retrieve the specified header value. Header names should include the trailing colon (:).

  • SetHeader
    Pointer to the SetHeader function, which can be used to modify or delete the value of a header. The function cannot be used to modify the portions included in the request line that are specified by the special values.

  • AddHeader
    Pointer to the AddHeader callback function, which can be used to add an HTTP header to the response.

  • HttpStatus
    The current HTTP status code.

  • dwReserved
    A DWORD data type reserved for later use.

Remarks

The Web proxy sends an SF_NOTIFY_SEND_RESPONSE notification by calling the HttpFilterProc entry-point function of each Web filter that is registered to receive the notification. The pvNotification parameter contains a pointer to an HTTP_FILTER_SEND_RESPONSE structure, and the notificationType parameter is set to SF_NOTIFY_SEND_RESPONSE.

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