Export (0) Print
Expand All

CredentialCache.GetCredential Method

Returns the NetworkCredential instance associated with the specified URI and authentication type.

[Visual Basic]
Public Overridable Function GetCredential( _
   ByVal uriPrefix As Uri, _
   ByVal authType As String _
) As NetworkCredential Implements ICredentials.GetCredential
[C#]
public virtual NetworkCredential GetCredential(
 Uri uriPrefix,
 string authType
);
[C++]
public: virtual NetworkCredential* GetCredential(
 Uri* uriPrefix,
 String* authType
);
[JScript]
public function GetCredential(
   uriPrefix : Uri,
 authType : String
) : NetworkCredential;

Parameters

uriPrefix
A Uri that specifies the URI prefix of the resources that the credential grants access to.
authType
The authentication scheme used by the resource named in uriPrefix.

Return Value

A NetworkCredential or, if there is no matching credential in the cache, a null reference (Nothing in Visual Basic).

Implements

ICredentials.GetCredential

Remarks

The GetCredential method searches the CredentialCache and returns the NetworkCredential instance for the specified URI and authorization type. If the CredentialCache contains no matching NetworkCredential instance, a null reference (Nothing in Visual Basic) 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.

Example

[Visual Basic, C#, C++] The following example uses the GetCredential method to return the NetworkCredential instance associated with the specified URI and authentication type.

[Visual Basic] 
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(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

[C#] 
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);
  }

[C++] 

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);
   }
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Common Language Infrastructure (CLI) Standard

See Also

CredentialCache Class | CredentialCache Members | System.Net Namespace

Show:
© 2014 Microsoft