GetAuthSchemeStatus Callback Function

Article
08/13/2010

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:

Syntax

BOOL WINAPI * GetAuthSchemeStatus(
  __in   struct _HTTP_FILTER_CONTEXT* pfc,
  __in   LPSTR lpszAuthSchemeNamespace,
  __out  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
Pointer to a Boolean variable that is set on return to TRUE if the scheme is enabled, or to FALSE if the scheme is disabled.

Return Value

This callback function returns TRUE if the call is successful; otherwise, it returns FALSE. To obtain extended error information, call GetLastError.

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 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
Header	Declared in Wpxhttpfilt.h.
DLL	Requires W3Filter.dll.

Share via