This documentation is archived and is not being maintained.

CHttpFilter::GetFilterVersion 

This member function is called by the internet server to get the filter version indicated by pVer.


virtual BOOL GetFilterVersion(
   PHTTP_FILTER_VERSION pVer 
);

Parameters

pVer

A pointer to the HTTP_FILTER_VERSION structure containing the server's version information and fields for the filter to indicate version number and notifications. The filter application also includes space to register a small description of itself. The following two flags are set in the structure by the default implementation:

  • dwFlags   The priority notification flag, SF_NOTIFY_ORDER_DEFAULT, is set by default. See Remarks for a list of the notification flags and their descriptions.

  • dwFilterVersion   HTTP_FILTER_REVISION is set by default. This flag indicates the version of the specification used by the server.

Nonzero if the filter was properly loaded. If the filter returns 0, then the filter application will be unloaded and it will not receive any notifications.

It is called only once, after the CHttpFilter object is constructed.

Use dwFlags to specify the notifications in the pVer member that interest your server. Here is a list of the valid flags for dwFlags:

SF_NOTIFY_ORDER_DEFAULT

Loads the filter at the default priority. This value is recommended because other priority notifications can have a strong impact on performance and scalability.

SF_NOTIFY_ORDER_LOW

Loads the filter at low priority.

SF_NOTIFY_ORDER_MEDIUM

Loads the filter at medium priority.

SF_NOTIFY_ORDER_HIGH

Loads the filter at high priority.

SF_NOTIFY_SECURE_PORT

Notifies the application that it is passing data through a secure port.

SF_NOTIFY_NONSECURE_PORT

Notifies the application that it is passing data through a nonsecure port.

NoteNote

If you set neither SF_NOTIFY_NONSECURE_PORT nor SF_NOTIFY_SECURE_PORT, the server defaults to both, which allows processing data through any port.

SF_NOTIFY_READ_RAW_DATA

Allows the application to see the raw data. The data returned to the client will contain both headers and data.

SF_NOTIFY_PREPROC_HEADERS

The server has pre-processed the headers.

SF_NOTIFY_AUTHENTICATION

The server is authenticating the client.

SF_NOTIFY_URL_MAP

The server is mapping a logical URL to a physical path.

SF_NOTIFY_SEND_RAW_DATA

The server is sending raw data back to the client.

SF_NOTIFY_LOG

The server is writing information to the server log.

SF_NOTIFY_END_OF_NET_SESSION

The session with the client is ending.

Show: