This documentation is archived and is not being maintained.

CredentialCache.GetEnumerator Method

Returns an enumerator that can iterate through the CredentialCache instance.

[Visual Basic]
Public Overridable Function GetEnumerator() As IEnumerator _
   Implements IEnumerable.GetEnumerator
[C#]
public virtual IEnumerator GetEnumerator();
[C++]
public: virtual IEnumerator* GetEnumerator();
[JScript]
public function GetEnumerator() : IEnumerator;

Return Value

An IEnumerator for the CredentialCache.

Implements

IEnumerable.GetEnumerator

Example

[Visual Basic, C#, C++] The following example uses the GetEnumerator method to return an enumerator that can iterate through the CredentialCache instance.

[Visual Basic] 
Try
            Dim myCredentialCache As New CredentialCache()
            ' Dummy Credentials used here.             
            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))
            Dim myWebRequest As WebRequest = WebRequest.Create(url) 'Creates a webrequest with the specified url 
            myWebRequest.Credentials = myCredentialCache
            Dim listCredentials As IEnumerator = myCredentialCache.GetEnumerator()
            Console.WriteLine("Displaying credentials stored in CredentialCache: ")
            While listCredentials.MoveNext()
Display(CType(listCredentials.Current, NetworkCredential))
            End While
            Console.WriteLine(ControlChars.Cr + "Now Displaying using 'foreach': ")
            ' Can use foreach with CredentialCache(Since GetEnumerator method of IEnumerable has been implemented by 'CredentialCache' class.
            Dim credential As NetworkCredential
            For Each credential In  myCredentialCache
Display(credential)
            Next credential
            Dim myWebResponse As WebResponse = myWebRequest.GetResponse() 'Sends the request and waits for response.
            ' Process the 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(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 Credentials used here.             
         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.                 
         WebRequest myWebRequest = WebRequest.Create(url);
         myWebRequest.Credentials = myCredentialCache;            
         IEnumerator listCredentials = myCredentialCache.GetEnumerator();
         
         Console.WriteLine("\nDisplaying credentials stored in CredentialCache: ");
         while(listCredentials.MoveNext())
         {
             Display((NetworkCredential)listCredentials.Current);
         }
         Console.WriteLine("\nNow Displaying the same using 'foreach' : ");
         // Can use foreach with CredentialCache(Since GetEnumerator function of IEnumerable has been implemented by 'CredentialCache' class.
         foreach(NetworkCredential credential in myCredentialCache)
             Display(credential);
         // Send 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("\n\tUsername : {0} ,Password : {1} ,Domain : {2}",credential.UserName,credential.Password,credential.Domain);
  }

[C++] 
void Display(NetworkCredential* credential)
{
   Console::WriteLine(S"\n\tUsername : {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 Credentials used here.
      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));
      // Creates a webrequest with the specified url.
      WebRequest* myWebRequest = WebRequest::Create(url);
      myWebRequest->Credentials = myCredentialCache;
      IEnumerator* listCredentials = myCredentialCache->GetEnumerator();

      Console::WriteLine(S"\nDisplaying credentials stored in CredentialCache: ");
      while(listCredentials->MoveNext())
         Display(dynamic_cast<NetworkCredential*>(listCredentials->Current));
      Console::WriteLine(S"\nNow Displaying the same using 'foreach' : ");
      // Can use foreach with CredentialCache(Since GetEnumerator function of IEnumerable* has been implemented by 'CredentialCache' class.
      IEnumerator* myEnum = myCredentialCache->GetEnumerator();
      while (myEnum->MoveNext())
      {
         NetworkCredential* credential = __try_cast<NetworkCredential*>(myEnum->Current);
         Display(credential);
      }
      // Send 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: