.NET Framework Class Library
WebClient..::.Credentials Property

Gets or sets the network credentials that are sent to the host and used to authenticate the request.

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

Visual Basic (Declaration)
Public Property Credentials As ICredentials
Visual Basic (Usage)
Dim instance As WebClient
Dim value As ICredentials

value = instance.Credentials

instance.Credentials = value
C#
public ICredentials Credentials { get; set; }
Visual C++
public:
property ICredentials^ Credentials {
    ICredentials^ get ();
    void set (ICredentials^ value);
}
JScript
public function get Credentials () : ICredentials
public function set Credentials (value : ICredentials)

Property Value

Type: System.Net..::.ICredentials
An ICredentials containing the authentication credentials for the request. The default is nullNothingnullptra null reference (Nothing in Visual Basic).
Remarks

The Credentials property contains the authentication credentials used to access a resource on a host. In most client-side scenarios, you should use the DefaultCredentials, which are the credentials of the currently logged on user. To do this, set the UseDefaultCredentials property to true instead of setting this property.

If the WebClient class is being used in a middle tier application, such as an ASP.NET application, the DefaultCredentials belong to the account running the ASP page (the server-side credentials). Typically, you would set this property to the credentials of the client on whose behalf the request is made.

Examples

The following code example uses the user's system credentials to authenticate a request.

Visual Basic
Public Shared Sub Main()
    Try
        Dim client As New WebClient()

        client.Credentials = CredentialCache.DefaultCredentials

        Dim pageData As [Byte]() = client.DownloadData("http://www.contoso.com")
        Dim pageHtml As String = Encoding.ASCII.GetString(pageData)

        Console.WriteLine(pageHtml)

    Catch webEx As WebException
        Console.Write(webEx.ToString())
    End Try
End Sub 
C#
    public static void Main()
    {           
        try {

            WebClient client = new WebClient();

              client.Credentials = CredentialCache.DefaultCredentials;
    
            Byte[] pageData = client.DownloadData("http://www.contoso.com");
            string pageHtml = Encoding.ASCII.GetString(pageData);
            Console.WriteLine(pageHtml);

        } catch (WebException webEx) {
            Console.Write(webEx.ToString());
        }
    }    
Visual C++
int main()
{
   try
   {
      WebClient^ client = gcnew WebClient;
      client->Credentials = CredentialCache::DefaultCredentials;
      array<Byte>^pageData = client->DownloadData( "http://www.contoso.com" );
      String^ pageHtml = Encoding::ASCII->GetString( pageData );
      Console::WriteLine( pageHtml );
   }
   catch ( WebException^ webEx ) 
   {
      Console::Write( webEx );
   }

}

JScript
    public static function Main()
    {           
        try {

            var client : WebClient = new WebClient();

            client.Credentials = CredentialCache.DefaultCredentials;

            var pageData : Byte[] = client.DownloadData("http://www.contoso.com");
            var pageHtml : String = Encoding.ASCII.GetString(pageData);
            Console.WriteLine(pageHtml);

        } catch (webEx : WebException) {
            Console.Write(webEx.ToString());
        }
    }    
CPP_OLD
int main()
{
   try
   {
      WebClient* client = new WebClient();
      client -> Credentials = CredentialCache::DefaultCredentials;
      Byte pageData[] = client -> DownloadData(S"http://www.contoso.com");
      String* pageHtml = Encoding::ASCII -> GetString(pageData);
      Console::WriteLine(pageHtml);

   }
   catch (WebException* webEx)
   {
      Console::Write(webEx);
   }
}    
Platforms

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

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.
Version Information

.NET Framework

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

Reference

Tags : webclient


Page view tracker