UploadComplete Event

Fired when an Upload operation completes (or fails).

Syntax

public event OnUploadCompleteHandler OnUploadComplete;

public delegate void OnUploadCompleteHandler(object sender, SshplexUploadCompleteEventArgs e);

public class SshplexUploadCompleteEventArgs : EventArgs {
  public string OperationId { get; }
  public int ErrorCode { get; }
  public string ErrorDescription { get; }
  public string LocalFile { get; }
  public string RemoteFile { get; }
  public string RemotePath { get; }
}
Public Event OnUploadComplete As OnUploadCompleteHandler

Public Delegate Sub OnUploadCompleteHandler(sender As Object, e As SshplexUploadCompleteEventArgs)

Public Class SshplexUploadCompleteEventArgs Inherits EventArgs
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property ErrorDescription As String
  Public ReadOnly Property LocalFile As String
  Public ReadOnly Property RemoteFile As String
  Public ReadOnly Property RemotePath As String
End Class

Remarks

This event fires when an Upload operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

LocalFile is the local file that was specified when the operation was initiated.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 .NET Edition - Version 20.0 [Build 8501]