AuthenticationManager.Unregister Method

Definition

Namespace:

System.Net

Assembly:

System.Net.Requests.dll

Removes authentication modules from the list of registered modules.

Overloads

Unregister(IAuthenticationModule)	Removes the specified authentication module from the list of registered modules.
Unregister(String)	Removes authentication modules with the specified authentication scheme from the list of registered modules.

Unregister(IAuthenticationModule)

Source:

AuthenticationManager.cs

Removes the specified authentication module from the list of registered modules.

public:
 static void Unregister(System::Net::IAuthenticationModule ^ authenticationModule);

public static void Unregister (System.Net.IAuthenticationModule authenticationModule);

static member Unregister : System.Net.IAuthenticationModule -> unit

Public Shared Sub Unregister (authenticationModule As IAuthenticationModule)

Parameters

authenticationModule

IAuthenticationModule

The IAuthenticationModule to remove from the list of registered modules.

Exceptions

ArgumentNullException

authenticationModule is null.

InvalidOperationException

The specified IAuthenticationModule is not registered.

Examples

The following example uses the Unregister method to remove the specified authentication module from the list of registered modules. For a complete example, refer to the AuthenticationManager class.

// This is the program entry point. It allows the user to enter 
// her credentials and the Internet resource (Web page) to access.
// It also unregisters the standard and registers the customized basic 
// authentication.
static void Main()
{
   array<String^>^args = Environment::GetCommandLineArgs();
   if ( args->Length < 4 )
         showusage();
   else
   {
      
      // Read the user's credentials.
      uri = args[ 1 ];
      username = args[ 2 ];
      password = args[ 3 ];
      if ( args->Length == 4 )
               domain = String::Empty; // If the domain exists, store it. Usually the domain name
      else
               domain = args[ 4 ];

      
      // is by default the name of the server hosting the Internet
      // resource.
      // Unregister the standard Basic authentication module.
      AuthenticationManager::Unregister( "Basic" );
      
      // Instantiate the custom Basic authentication module.
      CustomBasic^ customBasicModule = gcnew CustomBasic;
      
      // Register the custom Basic authentication module.
      AuthenticationManager::Register( customBasicModule );
      
      // Display registered Authorization modules.
      displayRegisteredModules();
      
      // Read the specified page and display it on the console.
      getPage( uri );
   }

   return;
}

// This is the program entry point. It allows the user to enter
// her credentials and the Internet resource (Web page) to access.
// It also unregisters the standard and registers the customized basic
// authentication.
public static void Main(string[] args)
{

  if (args.Length < 3)
        {
            ShowUsage();
        }
        else
  {

    // Read the user's credentials.
    uri = args[0];
    username = args[1];
    password = args[2];

    if (args.Length == 3)
      domain = string.Empty;
    else
      // If the domain exists, store it. Usually the domain name
      // is by default the name of the server hosting the Internet
      // resource.
      domain = args[3];

    // Unregister the standard Basic authentication module.
    AuthenticationManager.Unregister("Basic");

    // Instantiate the custom Basic authentication module.
    CustomBasic customBasicModule = new CustomBasic();

    // Register the custom Basic authentication module.
    AuthenticationManager.Register(customBasicModule);

    // Display registered Authorization modules.
    DisplayRegisteredModules();

    // Read the specified page and display it on the console.
    GetPage(uri);
  }
  return;
}

   ' This is the program entry point. It allows the user to enter 
   ' her credentials and the Internet resource (Web page) to access.
   ' It also unregisters the standard and registers the customized basic 
   ' authentication.
  Private Overloads Shared Sub Main(ByVal args() As String)

    If args.Length < 4 Then
      showusage()
    Else

      ' Read the user's credentials.
      uri = args(1)
      username = args(2)
      password = args(3)

      If args.Length = 4 Then
        domain = String.Empty
        ' If the domain exists, store it. Usually the domain name
        ' is by default the name of the server hosting the Internet
        ' resource.
      Else
        domain = args(5)
      End If
      ' Unregister the standard Basic authentication module.
      AuthenticationManager.Unregister("Basic")

      ' Instantiate the custom Basic authentication module.
      Dim customBasicModule As New CustomBasic()

      ' Register the custom Basic authentication module.
      AuthenticationManager.Register(customBasicModule)

      ' Display registered Authorization modules.
      displayRegisteredModules()

      ' Read the specified page and display it on the console.
      getPage(uri)
    End If
    Return
  End Sub
End Class

Remarks

The Unregister method removes the specified authentication module from the list of authentication modules called by the Authenticate method. The module must have been added to the list using the Register method before it can be removed from the list.

Unregister(String)

Source:

AuthenticationManager.cs

Removes authentication modules with the specified authentication scheme from the list of registered modules.

public:
 static void Unregister(System::String ^ authenticationScheme);

public static void Unregister (string authenticationScheme);

static member Unregister : string -> unit

Public Shared Sub Unregister (authenticationScheme As String)

Parameters

authenticationScheme

String

The authentication scheme of the module to remove.

Exceptions

ArgumentNullException

authenticationScheme is null.

InvalidOperationException

A module for this authentication scheme is not registered.

Examples

The following example uses the Unregister method to remove an authentication module with the specified authentication scheme from the list of registered modules.

IEnumerator^ registeredModules = AuthenticationManager::RegisteredModules;
// Display all the modules that are already registered with the system.
DisplayAllModules();
registeredModules->Reset();
registeredModules->MoveNext();
// Get the first Authentication module registered with the system.
IAuthenticationModule^ authenticationModule1 = dynamic_cast<IAuthenticationModule^>(registeredModules->Current);
// Call the UnRegister() method to unregister the first authentication module from the system.
String^ authenticationScheme = authenticationModule1->AuthenticationType;
AuthenticationManager::Unregister( authenticationScheme );
Console::WriteLine(  "\nSuccessfully unregistered '{0}'.", authenticationModule1 );
// Display all modules to see that the module was unregistered.
DisplayAllModules();

IEnumerator registeredModules = AuthenticationManager.RegisteredModules;
// Display all the modules that are already registered with the system.
DisplayAllModules();
registeredModules.Reset();
registeredModules.MoveNext();
// Get the first Authentication module registered with the system.
IAuthenticationModule authenticationModule1 = (IAuthenticationModule)registeredModules.Current;
// Call the UnRegister() method to unregister the first authentication module from the system.
String authenticationScheme = authenticationModule1.AuthenticationType;
AuthenticationManager.Unregister(authenticationScheme);
Console.WriteLine("\nSuccessfully unregistered '{0}",authenticationModule1+"'.");
// Display all modules to see that the module was unregistered.
DisplayAllModules();

Dim registeredModules As IEnumerator = AuthenticationManager.RegisteredModules
DisplayAllModules()

registeredModules.Reset()
registeredModules.MoveNext()

'Get the first Authentication module registered with the system
Dim authenticationModule1 As IAuthenticationModule = CType(registeredModules.Current, IAuthenticationModule)

'Call the UnRegister method to unregister the first authentication module from the system.
Dim authenticationScheme As [String] = authenticationModule1.AuthenticationType
AuthenticationManager.Unregister(authenticationScheme)
Console.WriteLine(ControlChars.Cr + "Successfully unregistered {0}", authenticationModule1)
'Display all modules to see that the module was unregistered.
DisplayAllModules()
'Call the Register method to register authenticationModule1 module again.
AuthenticationManager.Register(authenticationModule1)
Console.WriteLine(ControlChars.Cr + "Successfully re-registered {0}", authenticationModule1)
'Display the modules to verify that 'authenticationModule1' has been registered again.
DisplayAllModules()

Remarks

The Unregister method removes the authentication module with the specified authentication scheme from the list of authentication modules called by the Authenticate method. The module must have been added to the list using the Register method before it can be removed from the list.