ExecuteComplete Event

Fired when an Execute operation completes (or fails).

Syntax

• C#
• VB.NET

public event OnExecuteCompleteHandler OnExecuteComplete;

public delegate void OnExecuteCompleteHandler(object sender, SshplexExecuteCompleteEventArgs e);

public class SshplexExecuteCompleteEventArgs : EventArgs {
  public string OperationId { get; }
  public int ErrorCode { get; }
  public string ErrorDescription { get; }
  public int ExitStatus { get; }
}

Public Event OnExecuteComplete As OnExecuteCompleteHandler

Public Delegate Sub OnExecuteCompleteHandler(sender As Object, e As SshplexExecuteCompleteEventArgs)

Public Class SshplexExecuteCompleteEventArgs Inherits EventArgs
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property ErrorDescription As String
  Public ReadOnly Property ExitStatus As Integer
End Class

Remarks

This event fires when an Execute 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.

ExitStatus is the exit code of the executed command. If an error message is returned it is present in ErrorDescription.