Microsoft Internet Security and Acceleration Server 2004 SDK

GetAuthSchemeStatus

The GetAuthSchemeStatus callback function returns the status (enabled or disabled) of a custom authentication scheme for the current listener. A Web filter that adds an authentication mechanism should use this function to determine if that scheme is enabled for the given request.

The GetAuthSchemeStatus callback function is declared as:

BOOL WINAPI * GetAuthSchemeStatus(
  struct _HTTP_FILTER_CONTEXT* pfc,
  LPSTR lpszAuthSchemeNamespace,
  BOOL* lpfStatus
);

Parameters

pfc
Pointer to the HTTP_FILTER_CONTEXT data structure that is associated with the current, active HTTP session. Pass the filter context in this parameter.
lpszAuthSchemeNamespace
Pointer to a null-terminated string containing the name of the authentication scheme. This parameter is not case-sensitive.
lpfStatus
[out] Pointer to a null-terminated string containing a Boolean value that will be set to TRUE if the scheme is enabled, or FALSE if not. This value is set upon the function's return.

Return Values

Returns TRUE if the function succeeded, or FALSE if the function failed.

Remarks

The GetAuthSchemeStatus 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 callling the GetAuthSchemeStatus function, use the TO_WPX_FILTER_CONTEXT macro as follows:

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

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Wpxhttpfilt.h.

See Also

Callback Functions