Export (0) Print
Expand All
1 out of 3 rated this helpful - Rate this topic

WebRequest.Credentials Property

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

[Visual Basic]
Public Overridable Property Credentials As ICredentials
[C#]
public virtual ICredentials Credentials {get; set;}
[C++]
public: __property virtual ICredentials* get_Credentials();
public: __property virtual void set_Credentials(ICredentials*);
[JScript]
public function get Credentials() : ICredentials;
public function set Credentials(ICredentials);

Property Value

An ICredentials containing the authentication credentials associated with the request. The default is a null reference (Nothing in Visual Basic).

Exceptions

Exception Type Condition
NotSupportedException 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 (MustInherit in Visual Basic) 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.

Example

[Visual Basic, C#, C++] The following example collects username and password information from the user and creates a NetworkCredential with this information. The Credentials property is set with this NetworkCredential. When the request is made, credentials stored in this property are used to validate the requesters access.

[Visual Basic] 

' Create a new webrequest to the mentioned URL.
Dim myWebRequest As WebRequest = WebRequest.Create(url)

' Set 'Preauthenticate'  property to true.
myWebRequest.PreAuthenticate = True
Console.WriteLine(ControlChars.Cr + "Please Enter ur credentials for the requested Url")
Console.WriteLine("UserName")
Dim UserName As String = Console.ReadLine()
Console.WriteLine("Password")
Dim Password As String = Console.ReadLine()

' Create a New 'NetworkCredential' object.
Dim networkCredential As New NetworkCredential(UserName, Password)

' Associate the 'NetworkCredential' object with the 'WebRequest' object.
myWebRequest.Credentials = networkCredential

' Assign the response object of 'WebRequest' to a 'WebResponse' variable.
Dim myWebResponse As WebResponse = myWebRequest.GetResponse()


[C#] 

                     // Create a new webrequest to the mentioned URL.
            WebRequest myWebRequest=WebRequest.Create(url);

            // Set 'Preauthenticate'  property to true.  Credentials will be sent with the request.
            myWebRequest.PreAuthenticate=true;

            Console.WriteLine("\nPlease Enter ur credentials for the requested Url");
                     Console.WriteLine("UserName");
            string UserName=Console.ReadLine();
            Console.WriteLine("Password");
            string Password=Console.ReadLine();

            // Create a New 'NetworkCredential' object.
            NetworkCredential networkCredential=new NetworkCredential(UserName,Password);

            // Associate the 'NetworkCredential' object with the 'WebRequest' object.
            myWebRequest.Credentials=networkCredential;

            // Assign the response object of 'WebRequest' to a 'WebResponse' variable.
            WebResponse myWebResponse=myWebRequest.GetResponse();
            

[C++] 
// Create a new webrequest to the mentioned URL.
WebRequest* myWebRequest=WebRequest::Create(url);

// Set 'Preauthenticate' property to true. Credentials will be sent with the request.
myWebRequest->PreAuthenticate=true;

Console::WriteLine(S"\nPlease Enter your credentials for the requested Url");
Console::WriteLine(S"UserName");
String* UserName=Console::ReadLine();
Console::WriteLine(S"Password");
String* Password=Console::ReadLine();

// Create a New 'NetworkCredential' object.
NetworkCredential* networkCredential =
   new NetworkCredential(UserName, Password);

// Associate the 'NetworkCredential' object with the 'WebRequest' object.
myWebRequest->Credentials=networkCredential;

// Assign the response object of 'WebRequest' to a 'WebResponse' variable.
WebResponse* myWebResponse=myWebRequest->GetResponse();

[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, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

WebRequest Class | WebRequest Members | System.Net Namespace | NetworkCredential | CredentialCache | HttpWebRequest.Credentials

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.