diff --git a/Renci.SshClient/Renci.SshNet/SshClient.cs b/Renci.SshClient/Renci.SshNet/SshClient.cs index 74e646e9..a85c516a 100644 --- a/Renci.SshClient/Renci.SshNet/SshClient.cs +++ b/Renci.SshClient/Renci.SshNet/SshClient.cs @@ -222,7 +222,11 @@ namespace Renci.SshNet /// Creates and executes the command. /// /// The command text. - /// + /// Returns an instance of with execution results. + /// This method internally uses asynchronous calls. + /// CommandText property is empty. + /// Invalid Operation - An existing channel was used to execute this command. + /// Asynchronous operation is already in progress. public SshCommand RunCommand(string commandText) { var cmd = this.CreateCommand(commandText); @@ -243,7 +247,7 @@ namespace Renci.SshNet /// The height. /// The terminal mode. /// Size of the internal read buffer. - /// + /// Returns a representation of a object. public Shell CreateShell(Stream input, Stream output, Stream extendedOutput, string terminalName, uint columns, uint rows, uint width, uint height, string terminalMode, int bufferSize) { // Ensure that connection is established. @@ -264,7 +268,7 @@ namespace Renci.SshNet /// The width. /// The height. /// The terminal mode. - /// + /// Returns a representation of a object. public Shell CreateShell(Stream input, Stream output, Stream extendedOutput, string terminalName, uint columns, uint rows, uint width, uint height, string terminalMode) { return this.CreateShell(input, output, extendedOutput, terminalName, columns, rows, width, height, terminalMode, 1024); @@ -276,7 +280,7 @@ namespace Renci.SshNet /// The input. /// The output. /// The extended output. - /// + /// Returns a representation of a object. public Shell CreateShell(Stream input, Stream output, Stream extendedOutput) { return this.CreateShell(input, output, extendedOutput, string.Empty, 0, 0, 0, 0, string.Empty, 1024); @@ -296,7 +300,7 @@ namespace Renci.SshNet /// The height. /// The terminal mode. /// Size of the internal read buffer. - /// + /// Returns a representation of a object. public Shell CreateShell(Encoding encoding, string input, Stream output, Stream extendedOutput, string terminalName, uint columns, uint rows, uint width , uint height , string terminalMode, int bufferSize) { // Ensure that connection is established. @@ -324,7 +328,7 @@ namespace Renci.SshNet /// The width. /// The height. /// The terminal mode. - /// + /// Returns a representation of a object. public Shell CreateShell(Encoding encoding, string input, Stream output, Stream extendedOutput, string terminalName, uint columns, uint rows, uint width, uint height, string terminalMode) { return this.CreateShell(encoding, input, output, extendedOutput, terminalName, columns, rows, width, height, terminalMode, 1024); @@ -337,7 +341,7 @@ namespace Renci.SshNet /// The input. /// The output. /// The extended output. - /// + /// Returns a representation of a object. public Shell CreateShell(Encoding encoding, string input, Stream output, Stream extendedOutput) { return this.CreateShell(encoding, input, output, extendedOutput, string.Empty, 0, 0, 0, 0, string.Empty, 1024);