The Scripting type exposes the following members.
Methods
Name | Description | |
---|---|---|
Close |
Closes the connection to the server.
| |
DetectPrompt |
Detects the prompt which the server currently uses and sets the Prompt property.
| |
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.) | |
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.) | |
CheckFor(ScriptEvent) |
Checks whether the specified condition is currently met.
| |
CheckFor(array<ScriptEvent>[]()[][]) |
Checks whether the specified conditions are currently met. The events are processed as if the OR operator was applied.
| |
KeepAlive |
Sends a keep alive packet (NOOP) to the server.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Process()()()() |
Processes response from the server. If no data is available to be received, waits until the Timeout interval expires.
| |
Process(Int32) |
Processes response from the server. If no data is available to be received, waits until the specified interval expires.
| |
ReadChar |
Receives a printable character from the server.
| |
ReadLine |
Receives response from the server until an end-of-line sequence is received.
| |
ReadUntil(ScriptEvent) |
Receives response from the server until the specified condition is met.
| |
ReadUntil(array<ScriptEvent>[]()[][]) |
Reads the response from previously sent command until the criteria are met. The events are processed as if the OR operator was applied.
| |
ReadUntilPrompt |
Receives response from the server until the Prompt is received.
| |
Send(String) |
Sends text to the server.
| |
Send(ConsoleKeyInfo) |
Sends a key to the server. This is used for sending simple keys or combinations such as Ctrl+C.
| |
Send(FunctionKey) |
Sends a key to the server. This is used for sending function keys such as Enter or F10.
| |
Send(ConsoleKey, ConsoleModifiers) |
Sends a key to the server.
| |
Send(FunctionKey, ConsoleModifiers) |
Sends a key to the server.
| |
SendBreak |
Sends a break request to the server. This may or may not have an effect, depending on the server. Sending Ctrl+C using Send(ConsoleKey, ConsoleModifiers) is usually more reliable.
| |
SendCommand |
Sends a command to the server and waits for the server to accept it.
| |
SendData |
Sends raw data to the server.
| |
ToString | Returns a String that represents the current Object. (Inherited from Object.) | |
WaitFor(ScriptEvent) |
Receives response from the server until a condition is met.
| |
WaitFor(array<ScriptEvent>[]()[][]) |
Processes response from the server until a condition is met. The events are processed as if the OR operator was applied.
|
Properties
Name | Description | |
---|---|---|
AutoMatchPrompt |
Gets or sets whether to automatically match prompt in WaitFor(ScriptEvent), ReadUntil(ScriptEvent),
ReadUntilPrompt()()()(), ReadLine()()()(), ReadChar()()()() and CheckFor(ScriptEvent) methods.
Default value is false.
| |
FinalExitCode |
Gets the exit code of the receiving channel when the connection was closed.
| |
HoldReceivedData |
Gets or sets a value indicating whether to hold received data in DataReceived()()()() property.
Default value is true.
| |
LastResult |
Gets the result of last called ReadUntilPrompt()()()(), ReadLine()()()(), ReadChar()()()() or ReadUntil(ScriptEvent) method. Please note that calling other scripting methods reset this to null.
| |
Prompt |
Gets or sets the sequence that is used to detect command prompt.
To use regular expressions, prepend the string with "regex:".
To use wildcards, prepend the string with "mask:".
Prompt sequence is used by ReadUntilPrompt()()()() method (and other methods if Prompt is specified).
To detect the current prompt automatically , use DetectPrompt()()()() method.
| |
ReceivedData |
Gets data received since the previous data-receiving method.
If HoldReceivedData is set to false, this returns null.
| |
Terminal |
Gets the containing terminal object.
| |
Timeout |
Gets or sets the timeout for receiving data in milliseconds.
Default value is one minute.
| |
TrimReadUntilResponse |
Gets or sets a value indicating whether ReadUntilPrompt()()()(), ReadLine()()()(),
ReadChar()()()() and ReadUntil(ScriptEvent) methods remove the prompt or end-of-line from the returned value.
Default value is true.
|