The Shell type exposes the following members.
Constructors
Methods
Name | Description | |
---|---|---|
Close |
Closed the communication channel.
| |
DetectKnownShell |
This method is a part of the component infrastructure and is not intended to be used directly by user code.
| |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
GetExitCode |
Gets the exit code of the last command, if available. Only supported in Rebex SSH Shell with WellKnownShellMode
and for Ssh.StartCommand method. Not supported in Rebex Telnet.
| |
GetHashCode | Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ReadAll()()()() |
Reads a multi-line response from the server.
Returns null reference (Nothing in Visual Basic) if the end of response has been reached without any preceding data.
| |
ReadAll(array<String>[]()[][]) |
Reads a multi-line response from the server.
Returns if either the question prompt has been received (and no other data are pending)
or the end of response has been reached.
Returns null reference (Nothing in Visual Basic) if the end of response has been reached without any preceding data.
| |
ReadChar |
Reads a character from the server. Returns an EndOfResponse character if the end of response has been reached.
| |
ReadLine()()()() |
Reads a single line of response from the server.
Returns null reference (Nothing in Visual Basic) if the end of response has been reached without any preceding data.
| |
ReadLine(array<String>[]()[][]) |
Reads a single line of response from the server.
Returns if either end of line was detected or the question prompt has been received (and no other data are pending)
or the end of response has been reached.
Returns null reference (Nothing in Visual Basic) if the end of response has been reached without any preceding data.
| |
SendBreak |
Sends a break request to the server. This may or may not have any effect. Caution: some Telnet servers
don't handle this correctly, causing subsequent commands to fail!
| |
SendCommand(String) |
Sends a command to the server. This assumes that either there is no command running at the moment or that a question prompt was encountered.
| |
SendCommand(String, Boolean) |
Sends a command to the server. This assumes that either there is no command running at the moment or that a question prompt was encountered.
| |
ToString | Returns a String that represents the current Object. (Inherited from Object.) |
Fields
Name | Description | |
---|---|---|
EndOfResponse |
A character that is used by the ReadChar()()()() method to represent an end of response.
|
Properties
Name | Description | |
---|---|---|
Connected |
Returns a value indicating whether the Shell object is connected.
| |
Encoding |
Gets or sets the character encoding for incoming and outgoing data.
| |
IsRunning |
Returns a value indicating whether a command is currently running.
| |
LastMatchedPrompt |
Gets the last matched prompt (set when the end of command response has been reached).
Only works in prompt-based mode.
| |
Mode |
Gets the shell mode.
| |
Prompt | ||
StripEscapeSequences |
Gets or sets a value indicating whether to strip escape sequences from the incoming data.
| |
Timeout |
Gets or sets the length of time in milliseconds before an operation times out (specify -1 or 0 to indicate that the request does not time out).
|