Credentials Property
This documentation is archived and is not being maintained.

FtpWebRequest.Credentials Property

Gets or sets the credentials used to communicate with the FTP server.

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

'Declaration
Public Overrides Property Credentials As ICredentials

Property Value

Type: System.Net.ICredentials
An ICredentials instance; otherwise, Nothing if the property has not been set.

ExceptionCondition
ArgumentNullException

The value specified for a set operation is Nothing.

ArgumentException

An ICredentials of a type other than NetworkCredential was specified for a set operation.

InvalidOperationException

A new value was specified for this property for a request that is already in progress.

You are not required to specify credentials when connecting using anonymous logon. You must set the Credentials property by using a credential of type NetworkCredential; this ensures that the user name and password can be read and sent to the server.

Caution noteCaution

Credentials information is not encrypted when transmitted to the server unless the EnableSsl property is set to true.

Changing Credentials after calling the GetRequestStream, BeginGetRequestStream, GetResponse, or BeginGetResponse method causes an InvalidOperationException exception.

The following code example retrieves the value of this property and uses it to display the user name.


Console.WriteLine("User {0} {1}", request.Credentials.GetCredential(request.RequestUri, "basic").UserName, request.RequestUri)


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show:
© 2016 Microsoft