StartTransfer Event

Fired when a file starts downloading/uploading.

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, ScpStartTransferEventArgs e);

public class ScpStartTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string LocalFile { get; }
  public string RemoteFile { get; }
  public string RemotePath { get; }
  public string FilePermissions { get; set; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As ScpStartTransferEventArgs)

Public Class ScpStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property LocalFile As String
  Public ReadOnly Property RemoteFile As String
  Public ReadOnly Property RemotePath As String
  Public Property FilePermissions As String
End Class

Remarks

The StartTransfer event fires when the file starts transferring.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The LocalFile, RemoteFile, and RemotePath parameters provide information about the current transfer.

The FilePermissions parameter may be used to set the remote file permissions on file currently being uploaded. It will also be populated with the current permissions of the remote file when downloading. See FilePermissions for more details.