Class FtpResult

Namespace

FluentFTP

Assembly

FluentFTP.dll

Stores the result of a file transfer when UploadDirectory or DownloadDirectory is used.

public class FtpResult

Inheritance

object

FtpResult

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ValuePrinter.ObjectToString(object)

Constructors

FtpResult()

public FtpResult()

Properties

Exception

Gets the error that occurring during transferring this file, if any.

public Exception Exception { get; set; }

Property Value

Exception

IsDownload

Returns true if the file was downloaded, false if it was uploaded.

public bool IsDownload { get; set; }

Property Value

bool

IsFailed

Was there an error during transfer? You can read the Exception property for more details.

public bool IsFailed { get; set; }

Property Value

bool

IsSkipped

Was the file skipped?

public bool IsSkipped { get; set; }

Property Value

bool

IsSkippedByRule

Was the file skipped due to failing the rule condition?

public bool IsSkippedByRule { get; set; }

Property Value

bool

IsSuccess

Returns true if the file was downloaded/uploaded, or the file was already existing with the same file size.

public bool IsSuccess { get; set; }

Property Value

bool

LocalPath

Stores the absolute local path of the current file being transferred.

public string LocalPath { get; set; }

Property Value

string

Name

Gets the name and extension of the file.

public string Name { get; set; }

Property Value

string

RemotePath

Stores the absolute remote path of the current file being transferred.

public string RemotePath { get; set; }

Property Value

string

Size

Gets the size of the file, or 0 if unknown.

public long Size { get; set; }

Property Value

long

Type

Gets the type of file system object.

public FtpObjectType Type { get; set; }

Property Value

FtpObjectType

Methods

ToListItem(bool)

Convert this result to a FTP list item.

public FtpListItem ToListItem(bool useLocalPath)

Parameters

useLocalPath bool

Returns

FtpListItem

ToStatus()

Convert this object to a FtpStatus enum for quick comparison.

public FtpStatus ToStatus()

Returns

FtpStatus

ToString()

Human readable results

public override string ToString()

Returns

string