NAME

HTTP_FILTER_VERSION - administrative information about a filter.


SYNOPSIS

 #include "httpfilt.h"
 typedef struct _HTTP_FILTER_VERSION {
    DWORD     dwServerFilterVersion;
    DWORD     dwFilterVersion;
    CHAR      lpszFilterDesc[SF_MAX_FILTER_DESC_LEN+1];
    DWORD     dwFlags;
 } HTTP_FILTER_VERSION, *PHTTP_FILTER_VERSION;


DESCRIPTION

The single argument passed to GetFilterVersion, called once when a filter is loaded, is a pointer to a HTTP_FILTER_VERSION structure, in which the filter returns administrative information to the ISAPI runner.


DATA FIELDS

The two ...FilterVersion fields are integers in which the filter stores information about versions of software: dwServerFilterVersion encodes the version of ISAPI for which the filter was compiled, dwFilterVersion encodes the version of the filter. GetFilterVersion should set the former to the value of HTTP_FILTER_REVISION supplied by httpfilt.h; this is a macro indicating the version of ISAPI to which httpfilt.h relates. The dwFilterVersion may be set to any value, at the discretion of the filter's author; however, the MAKELONG(minor, major) macro (used in the definition of HTTP_FILTER_REVISION) is recommended as a way of encoding major and minor version numbers in a single integer.

The lpszFilterDesc buffer may be used to store the name of the filter: this name's length should not exceed SF_MAX_FILTER_DESC_LEN (also defined in httpfilt.h; the buffer has one more character's space, reserved for the '\\0' which terminates the name, stored as a C string).

The dwFlags field is a bit-mask indicating the requests the filter is to handle, the stages of processing at which it is to handle each and a `priority' which controls the order in which filters handle a stage, when several handle the same stage of a given request. The values for this field are documented in detail in the manual page for GetFilterVersion(3), which see.


SEE ALSO

isapi(7), GetFilterVersion(3).


FILES

$ZEUSHOME/web/include/httpfilt.h $ZEUSHOME/web/include/wintypes.h $ZEUSHOME/webadmin/docroot/docs/modules/isapi/*.html


COPYRIGHT

Copyright (C) 2000-2001 Zeus Technology Limited. All rights reserved.