FtpWebRequest.Credentials Property

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.Requests.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: FtpWebRequest.cs

Source:: FtpWebRequest.cs

Source:: FtpWebRequest.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 virtual property System::Net::ICredentials ^ Credentials { System::Net::ICredentials ^ get(); void set(System::Net::ICredentials ^ value); };

public override System.Net.ICredentials? Credentials { get; set; }

public override System.Net.ICredentials Credentials { get; set; }

member this.Credentials : System.Net.ICredentials with get, set

Public Overrides Property Credentials As ICredentials

Property Value

ICredentials

An ICredentials instance; otherwise, null if the property has not been set.

Exceptions

ArgumentNullException

The value specified for a set operation is null.

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.

Examples

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 );

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

Remarks

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

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.

Applies to