This documentation is archived and is not being maintained.

IAuthenticationModule.CanPreAuthenticate Property

Gets a value indicating whether the authentication module supports preauthentication.

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

bool CanPreAuthenticate { get; }
/** @property */
boolean get_CanPreAuthenticate ()

function get CanPreAuthenticate () : boolean

Property Value

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
{
  get
  {
    return m_authenticationType;
  }
}

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

private String m_authenticationType;
private boolean m_canPreAuthenticate;

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

// Define the authentication type. This type is then used to identify this
// custom authentication module. The default is set to Basic.
/** @property
 */
public String get_AuthenticationType()
{
    return m_authenticationType;
} //get_AuthenticationType

// Define the pre-authentication capabilities for the module. 
// The default is set to false.
/** @property
 */
public boolean get_CanPreAuthenticate()
{
    return m_canPreAuthenticate;
} //get_CanPreAuthenticate

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Show: