CredentialCache.Remove Method

Definition

Deletes a NetworkCredential instance from the cache.

Overloads

Remove(Uri, String)

Deletes a NetworkCredential instance from the cache if it is associated with the specified Uniform Resource Identifier (URI) prefix and authentication protocol.

Remove(String, Int32, String)

Deletes a NetworkCredential instance from the cache if it is associated with the specified host, port, and authentication protocol.

Remove(Uri, String)

Deletes a NetworkCredential instance from the cache if it is associated with the specified Uniform Resource Identifier (URI) prefix and authentication protocol.

public:
 void Remove(Uri ^ uriPrefix, System::String ^ authType);
public void Remove (Uri uriPrefix, string authType);
public void Remove (Uri? uriPrefix, string? authType);
member this.Remove : Uri * string -> unit
Public Sub Remove (uriPrefix As Uri, authType As String)

Parameters

uriPrefix
Uri

A Uri that specifies the URI prefix of the resources that the credential is used for.

authType
String

The authentication scheme used by the host named in uriPrefix.

Examples

The following code example uses this method to delete a NetworkCredential instance from the cache.

// Create a webrequest with the specified url.
WebRequest^ myWebRequest = WebRequest::Create( url );
myWebRequest->Credentials = myCredentialCache;
Console::WriteLine( "\nLinked CredentialCache to your request." );
// Send the request and wait for response.
WebResponse^ myWebResponse = myWebRequest->GetResponse();

// Process response here.

Console::Write( "Response received successfully." );

// Call 'Remove' method to dispose credentials for current Uri as not required further.
myCredentialCache->Remove( myWebRequest->RequestUri, "Basic" );
Console::WriteLine( "\nYour credentials have now been removed from the program's CredentialCache" );
myWebResponse->Close();
// Create a webrequest with the specified url.
WebRequest myWebRequest = WebRequest.Create(url);
myWebRequest.Credentials = myCredentialCache;
Console.WriteLine("\nLinked CredentialCache to your request.");
// Send the request and wait for response.
WebResponse myWebResponse = myWebRequest.GetResponse();

// Process response here.

Console.Write("Response received successfully.");
// Call 'Remove' method to dispose credentials for current Uri as not required further.
myCredentialCache.Remove(myWebRequest.RequestUri,"Basic");
Console.WriteLine("\nYour credentials have now been removed from the program's CredentialCache");
myWebResponse.Close();
' Create a webrequest with the specified url .
Dim myWebRequest As WebRequest = WebRequest.Create(url)
myWebRequest.Credentials = myCredentialCache
Console.WriteLine(ControlChars.Cr + "Linked CredentialCache to your request.")
' Send the request and wait for response.
Dim myWebResponse As WebResponse = myWebRequest.GetResponse()

'Process the response here

Console.Write("Response received successfully.")
'Call 'Remove' method to dispose credentials for current Uri as they would not be; 
'required in any of the future requests.
myCredentialCache.Remove(myWebRequest.RequestUri, "Basic")
Console.WriteLine(ControlChars.Cr + "Your credentials have now been removed from the program's CredentialCache")
myWebResponse.Close()

Remarks

This method removes a NetworkCredential instance from the CredentialCache if the specified URI prefix and authentication protocol match those associated with the credential. Multiple calls to the Remove method for the same NetworkCredential have no effect.

If authType is null or uriPrefix is null, or no matching credential is found in the cache, this method does nothing.

Applies to

Remove(String, Int32, String)

Deletes a NetworkCredential instance from the cache if it is associated with the specified host, port, and authentication protocol.

public:
 void Remove(System::String ^ host, int port, System::String ^ authenticationType);
public void Remove (string host, int port, string authenticationType);
public void Remove (string? host, int port, string? authenticationType);
member this.Remove : string * int * string -> unit
Public Sub Remove (host As String, port As Integer, authenticationType As String)

Parameters

host
String

A String that identifies the host computer.

port
Int32

A Int32 that specifies the port to connect to on host.

authenticationType
String

A String that identifies the authentication scheme used when connecting to host.

Remarks

This method removes a NetworkCredential instance from the CredentialCache if the specified host, port, and authentication protocol match those associated with the credential. Multiple calls to the Remove method for the same NetworkCredential have no effect.

If authType is null or uriPrefix is null, or no matching credential is found in the cache, this method does nothing.

Applies to