WebRequest.Credentials Property (System.Net)

Credentials Property

.NET Framework Class Library

WebRequest..::.Credentials Property

When overridden in a descendant class, gets or sets the network credentials used for authenticating the request with the Internet resource.

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

Syntax

Visual Basic (Declaration)

Public Overridable Property Credentials As ICredentials

Visual Basic (Usage)

Dim instance As WebRequest
Dim value As ICredentials

value = instance.Credentials

instance.Credentials = value

public virtual ICredentials Credentials { get; set; }

Visual C++

public:
virtual 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 associated with the request. The default is nullNothingnullptra null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
NotImplementedException	Any attempt is made to get or set the property, when the property is not overridden in a descendant class.

Remarks

The Credentials property contains the authentication credentials required to access the Internet resource.

Note:
The WebRequest class is an abstract class. The actual behavior of WebRequest instances at run time is determined by the descendant class returned by the WebRequest..::.Create method. For more information about default values and exceptions, see the documentation for the descendant classes, such as HttpWebRequest and FileWebRequest.

Examples

The following example sets the Credentials property using the default credentials of the current user. When the request is made, credentials stored in this property are used to validate the client. This is identical to setting the UseDefaultCredentials property to true.

Visual Basic

' Create a request for the URL.         
Dim request As WebRequest = WebRequest.Create("http://www.contoso.com/default.html")
' If required by the server, set the credentials.
request.Credentials = CredentialCache.DefaultCredentials
' Get the response.
Dim response As HttpWebResponse = CType(request.GetResponse(), HttpWebResponse)

// Create a request for the URL.         
WebRequest request = WebRequest.Create ("http://www.contoso.com/default.html");
// If required by the server, set the credentials.
request.Credentials = CredentialCache.DefaultCredentials;
// Get the response.
HttpWebResponse response = (HttpWebResponse)request.GetResponse ();

Visual C++

// Create a request for the URL.   
WebRequest^ request = WebRequest::Create( "http://www.contoso.com/default.html" );

// If required by the server, set the credentials.
request->Credentials = CredentialCache::DefaultCredentials;

// Get the response.
HttpWebResponse^ response = dynamic_cast<HttpWebResponse^>(request->GetResponse());

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, 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.

Version Information

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Reference

HttpWebRequest..::.Credentials