This documentation is archived and is not being maintained.

CredentialCache.GetCredential Method (Uri, String)

Returns the NetworkCredential instance associated with the specified Uniform Resource Identifier (URI) and authentication type.

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

'Declaration
Public Function GetCredential ( _
	uriPrefix As Uri, _
	authType As String _
) As NetworkCredential
'Usage
Dim instance As CredentialCache 
Dim uriPrefix As Uri 
Dim authType As String 
Dim returnValue As NetworkCredential 

returnValue = instance.GetCredential(uriPrefix, _
	authType)

Parameters

uriPrefix
Type: System.Uri

A Uri that specifies the URI prefix of the resources that the credential grants access to.

authType
Type: System.String

The authentication scheme used by the resource named in uriPrefix.

Return Value

Type: System.Net.NetworkCredential
A NetworkCredential or, if there is no matching credential in the cache, Nothing.

Implements

ICredentials.GetCredential(Uri, String)

ExceptionCondition
ArgumentNullException

uriPrefix or authType is Nothing.

The GetCredential(Uri, String) method searches the CredentialCache and returns the NetworkCredential instance for the specified URI and authorization type. If the CredentialCache contains no matching NetworkCredential instance, Nothing is returned.

GetCredential uses the longest matching URI prefix in the cache to determine which set of credentials to return for an authorization type. The following table shows examples.

URI Prefix

Matches

http://www.contoso.com/portal/news.htm

Requests for the specific Web page news.htm.

http://www.contoso.com/portal/

Requests for all content in the portal path, except the page news.htm.

http://www.contoso.com/

Requests for all resources at www.contoso.com, except those in the portal path.

The following code example uses the GetCredential(Uri, String) method to return the NetworkCredential instance associated with the specified URI and authentication type.

Public Shared Sub GetPage(url As String, userName As String, password As String, domainName As String)
    Try 
        Dim myCredentialCache As New CredentialCache()
        ' Dummy names used as credentials    
        myCredentialCache.Add(New Uri("http://microsoft.com/"), "Basic", New NetworkCredential("user1", "passwd1", "domain1"))
        myCredentialCache.Add(New Uri("http://msdn.com/"), "Basic", New NetworkCredential("user2", "passwd2", "domain2"))
        myCredentialCache.Add(New Uri(url), "Basic", New NetworkCredential(userName, password, domainName))
        ' Creates a webrequest with the specified url.  
        Dim myWebRequest As WebRequest = WebRequest.Create(url)
        ' Call 'GetCredential' to obtain the credentials specific to our Uri. 
        Dim myCredential As NetworkCredential = myCredentialCache.GetCredential(New Uri(url), "Basic")
        Display(myCredential)
        myWebRequest.Credentials = myCredential 'Associating only our credentials            
        ' Sends the request and waits for response. 
        Dim myWebResponse As WebResponse = myWebRequest.GetResponse()
        ' Process response here.
        Console.WriteLine(ControlChars.Cr + "Response Received.")
        myWebResponse.Close()

    Catch e As WebException
        If Not (e.Response Is Nothing) Then
            Console.WriteLine(ControlChars.Lf + ControlChars.Cr + "Failed to obtain a response. The following error occured : {0}", CType(e.Response, HttpWebResponse).StatusDescription)
        Else
            Console.WriteLine(ControlChars.Lf + ControlChars.Cr + "Failed to obtain a response. The following error occured : {0}", e.Status)
        End If 
    Catch e As Exception
        Console.WriteLine(ControlChars.Cr + "The following exception was raised : {0}", e.Message)
    End Try 
End Sub 'GetPage

Public Shared Sub Display(ByVal credential As NetworkCredential)
    Console.WriteLine("The credentials are: ")
    Console.WriteLine(ControlChars.Cr + "Username : {0} ,Password : {1} ,Domain : {2}", credential.UserName, credential.Password, credential.Domain)
End Sub 'Display
void Display(NetworkCredential* credential)
{
   Console::WriteLine(S"\nThe credentials are:");
   Console::WriteLine(S"\nUsername : {0} , Password : {1} , Domain : {2}", 
      credential->UserName, credential->Password, credential->Domain);
}

void GetPage(String* url, String* userName, String* password, String* domainName)
{
   try
   {
      CredentialCache* myCredentialCache = new CredentialCache();
      // Dummy names used as credentials.
      myCredentialCache->Add(new Uri(S"http://microsoft.com/"),
         S"Basic", new NetworkCredential(S"user1", S"passwd1", S"domain1"));
      myCredentialCache->Add(new Uri(S"http://msdn.com/"), S"Basic",
         new NetworkCredential(S"user2", S"passwd2", S"domain2"));
      myCredentialCache->Add(new Uri(url), S"Basic", new NetworkCredential(userName, password, domainName));
      // Create a webrequest with the specified url.
      WebRequest* myWebRequest = WebRequest::Create(url);
      // Call 'GetCredential' to obtain the credentials specific to our Uri.
      NetworkCredential* myCredential = myCredentialCache->GetCredential(new Uri(url), S"Basic");
      Display(myCredential);
      // Associating only our credentials.
      myWebRequest->Credentials = myCredential;
      // Sends the request and waits for response.
      WebResponse* myWebResponse = myWebRequest->GetResponse();

      // Process response here.

      Console::WriteLine(S"\nResponse Received.");
      myWebResponse->Close();
   }
   catch (WebException* e)
   {
      if (e->Response != 0)
         Console::WriteLine(S"\r\nFailed to obtain a response. The following error occured : {0}",
         (dynamic_cast<HttpWebResponse*>(e->Response))->StatusDescription);
      else
         Console::WriteLine(S"\r\nFailed to obtain a response. The following error occured : {0}",
         __box( e->Status));
   }
   catch (Exception* e)
   {
      Console::WriteLine(S"\nThe following exception was raised : {0}", e->Message);
   }
}

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

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0
Show: