Class FileTransferProgressEvent
Event fired while tracking the progress of a file transfer.
Inheritance
System.Object
FileTransferProgressEvent
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Moraware.JobTrackerAPI5
Assembly: JobTrackerAPI5.dll
Syntax
public class FileTransferProgressEventProperties
BytesSoFar
Number of bytes transfered so far.
Declaration
public int BytesSoFar { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
ExceptionObject
Holds any exception that may have occurred during the transfer.
Declaration
public Exception ExceptionObject { get; }Property Value
| Type | Description |
|---|---|
| System.Exception |
ExpectedBytes
Number of bytes expected to be transfered.
Declaration
public int ExpectedBytes { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Halted
Indicates whether or not the transfer has been cancelled.
Declaration
public bool Halted { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Status
Current status of the transfer. Use this property to determine the purpose for the FileTransferProgressEvent firing.
Declaration
public FileTransferProgressEvent.FileTransferEventProgressStatus_Enum Status { get; }Property Value
| Type | Description |
|---|---|
| FileTransferProgressEvent.FileTransferEventProgressStatus_Enum |
Methods
Halt()
Invoke this to signal that the transfer should be cancelled if possible. (It may be too late to stop it.)
Declaration
public void Halt()