IFWXRadiusAuthenticator::AuthenticateRadiusUser method

Article
08/27/2012

Applies to: desktop apps only

The AuthenticateRadiusUser method performs RADIUS authentication of the specified user in an asynchronous operation.

Syntax

HRESULT AuthenticateRadiusUser(
  [in]  BSTR bstrUsername,
  [in]  BSTR bstrUserPassword,
  [in]  IFWXAuthenticationCompletion *pIFWXAuthenticationCompletion,
  [in]  UserContextType UserData
);

Parameters

bstrUsername [in]
String value that specifies the user name with which to perform authentication.
bstrUserPassword [in]
String value that specifies the user password with which to perform authentication.
pIFWXAuthenticationCompletion [in]
Pointer to an IFWXAuthenticationCompletion interface.
UserData [in]
An opaque value that can be used to differentiate between authentication operations. This value will be passed in the UserData parameter of the CompleteAsyncAuthentication method on the IFWXAuthenticationCompletion interface specified in the pIFWXAuthenticationCompletion parameter when this authentication operation completes.

Return value

This method returns S_OK if the call is successful; otherwise, it returns a Windows error code, in which case the authentication operation is not initiated and the completion function will not be called.

Remarks

An application filter can use IFWXFirewall2::CreateRadiusAuthenticator to get the IFWXRadiusAuthenticator interface. When a request is received on a listener that has RADIUS authentication enabled, and the application filter needs to perform RADIUS authentication, it calls IFWXRadiusAuthenticator::AuthenticateRadiusUser and gives it the pointer to its IFWXAuthenticationCompletion interface.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
Header	Wspfwext.idl
DLL	Wspsrv.exe