SF_REQ_TYPE

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This enumeration defines the request types to use with the ServerSupportFunction (ISAPI Filters).

Syntax

enum SF_REQ_TYPE{
   SF_REQ_SEND_RESPONSE_HEADER,
   SF_REQ_ADD_HEADERS_ON_DENIAL,
   SF_REQ_SET_NEXT_READ_SIZE,
   SF_REQ_SET_PROXY_INFO,
   SF_REQ_GET_CONNID,
   SF_REQ_SET_CERTIFICATE_INFO,
   SF_REQ_GET_PROPERTY,
   SF_REQ_NORMALIZE_URL,
   SF_REQ_DISABLE_NOTIFICATIONS
} ;

Elements

• SF_REQ_SEND_RESPONSE_HEADER
  Allows your ISAPI filter to request the Web Server to send a complete HTTP server response header to the client browser, including the status, server version, message time, and MIME version. Server filters should append other information at the end, such as Content-type, Content-length, etc., followed by an extra "\r\n".

  The filter should set the pData parameter of ServerSupportFunction to a pointer to an optional zero-terminated status string, for example, "401 Access Denied", or NULL for the default response of "200 OK". The ul1 parameter of ServerSupportFunction should be set to optional data to be appended to and sent with the header. If this parameter is set to NULL, the header will be terminated with an empty line.

• SF_REQ_ADD_HEADERS_ON_DENIAL
  Allows your ISAPI filter to add specified headers to the server error response, in the event that the server denies the HTTP request. This allows an authentication filter to advertise its services without filtering every request.

  Note

  This request type will not work properly if passed to ServerSupportFunction during the processing of a SF_NOTIFY_SEND_RAW_DATA notification.

  The filter should set the pData parameter of ServerSupportFunction to a pointer to a zero-terminated string indicating one or more header lines with terminating "\r\n".

• SF_REQ_SET_NEXT_READ_SIZE
  Allows your ISAPI filter to set the size of the next read. This request type is only used by raw data filters that return SF_STATUS_READ_NEXT.

  A filter should set the ul1 parameter of ServerSupportFunction to the size, in bytes, for the next read.

• SF_REQ_SET_PROXY_INFO
  Allows your ISAPI filter to indicate an HTTP proxy request. A filter should set the ul1 parameter of ServerSupportFunction to the proxy flags to set.

• SF_REQ_GET_CONNID
  Allows your ISAPI filter to retrieve the connection identifier contained in the ConnID field of an ISAPI application's extension control block. The filter can use this identifier as a key to coordinate data that it shares with an application. The filter should set the pData parameter of ServerSupportFunction to a pointer to receive the connection identifier.

• SF_REQ_SET_CERTIFICATE_INFO
  Allows your ISAPI filter to set an SSPI security context plus impersonation token derived from a client certificate.

  The filter should set the pData parameter of ServerSupportFunction to a pointer to an HTTP_FILTER_CERTIFICATE_INFO structure containing certificate information. The filter should set the ul1 parameter of ServerSupportFunction to the context handle, and the ul2 parameter to the impersonation handle.

• SF_REQ_GET_PROPERTY
  Allows your ISAPI filter to retrieve an IIS property, as defined in SF_PROPERTY_IIS.

  The filter should set the ul1 parameter of ServerSupportFunction to the property identifier.

• SF_REQ_NORMALIZE_URL
  Allows your ISAPI filter to normalize a URL.

  The filter should set the pData parameter of ServerSupportFunction to a pointer to the URL.

• SF_REQ_DISABLE_NOTIFICATIONS
  Allows your ISAPI filter to disable specific notification types for the remaining lifetime of the request. If a particular notification event is disabled for your filter, the Web Server will not call the filter when that notification event occurs.

  The filter should set the ul1 parameter of ServerSupportFunction to the notifications to disable.

Requirements

See Also

Reference

ServerSupportFunction (ISAPI Filters)