IAuthenticationModule.CanPreAuthenticate Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a value indicating whether the authentication module supports preauthentication.

Namespace:   System.Net
Assembly:  System (in System.dll)

bool CanPreAuthenticate { get; }

Property Value

Type: System.Boolean

true if the authorization module supports preauthentication; otherwise false.

The CanPreAuthenticate property is set to true to indicate that the authentication module can respond with a valid Authorization instance when the PreAuthenticate method is called.

Notes to Implementers:

This is typically a fixed value; either the authentication module can preauthenticate, or it cannot.

The following example shows how to use the CanPreAuthenticate property. For a complete example refer to the AuthenticationManager class.

private string m_authenticationType ;
private bool m_canPreAuthenticate ;

// The CustomBasic constructor initializes the properties of the customized 
// authentication.
public CustomBasic()
  m_authenticationType = "Basic";
  m_canPreAuthenticate = false;

// Define the authentication type. This type is then used to identify this
// custom authentication module. The default is set to Basic.
public string AuthenticationType
    return m_authenticationType;

// Define the pre-authentication capabilities for the module. The default is set
// to false.
public bool CanPreAuthenticate
    return m_canPreAuthenticate;

.NET Framework
Available since 1.1
Return to top