RenameFileComplete Event

Fired when a RenameFile operation completes (or fails).

Syntax

• C#
• VB.NET

public event OnRenameFileCompleteHandler OnRenameFileComplete;

public delegate void OnRenameFileCompleteHandler(object sender, SshplexRenameFileCompleteEventArgs e);

public class SshplexRenameFileCompleteEventArgs : EventArgs {
  public string OperationId { get; }
  public int ErrorCode { get; }
  public string ErrorDescription { get; }
  public string RemoteFile { get; }
  public string RemotePath { get; }
  public string NewFileName { get; }
}

Public Event OnRenameFileComplete As OnRenameFileCompleteHandler

Public Delegate Sub OnRenameFileCompleteHandler(sender As Object, e As SshplexRenameFileCompleteEventArgs)

Public Class SshplexRenameFileCompleteEventArgs Inherits EventArgs
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property ErrorDescription As String
  Public ReadOnly Property RemoteFile As String
  Public ReadOnly Property RemotePath As String
  Public ReadOnly Property NewFileName As String
End Class

Remarks

This event fires when a RenameFile 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.

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.

NewFileName is the name to which the file was renamed as provided when RenameFile was originally called.