Export (0) Print
Expand All

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)

public NetworkCredential GetCredential(
	Uri uriPrefix,
	string 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, null.

Implements

ICredentials.GetCredential(Uri, String)

ExceptionCondition
ArgumentNullException

uriPrefix or authType is null.

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, null 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 static void GetPage(string url,string userName,string password,string domainName)
  {
      try 
      {
          CredentialCache myCredentialCache = 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));
          // 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),"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("\nResponse Received.");
          myWebResponse.Close();

      } 
      catch(WebException e) 
      {
          if (e.Response != null)
              Console.WriteLine("\r\nFailed to obtain a response. The following error occured : {0}",((HttpWebResponse)(e.Response)).StatusDescription); 
          else
              Console.WriteLine("\r\nFailed to obtain a response. The following error occured : {0}",e.Status); 
      }
      catch(Exception e)
      {
          Console.WriteLine("\nThe following exception was raised : {0}",e.Message);
      }
}
public static void Display(NetworkCredential credential)
{
  Console.WriteLine("\nThe credentials are:");
  Console.WriteLine("\nUsername : {0} ,Password : {1} ,Domain : {2}",credential.UserName,credential.Password,credential.Domain);
}


.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft