TTelnetShell - Revision history

Ultibo: Created page with "Return to Unit RemoteShell TOC === Description === ---- ''To be documented'' === Class definitions === ----

2018-05-28T05:41:16Z

Created page with "Return to Unit RemoteShell TOC === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsib..."

New page
Return to [[Unit_RemoteShell|Unit RemoteShell]]

TOC

=== Description ===
----

''To be documented''

=== Class definitions ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TTelnetShell = class(TShell)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>constructor Create;</code>
| style="width: 50%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FListener:TTelnetListener;</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure Reset(ASession:TTelnetSession);</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure MoveFirst(ASession:TTelnetSession);</code>
|  
|-
| <code>procedure MoveLast(ASession:TTelnetSession);</code>
|  
|-
| <code>procedure MoveLeft(ASession:TTelnetSession);</code>
|  
|-
| <code>procedure MoveRight(ASession:TTelnetSession);</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure EraseLine(ASession:TTelnetSession);</code>
|  
|-
| <code>procedure OutputLine(ASession:TTelnetSession; const AValue:String);</code>
|  
|-
| <code>function ExpandLine(ASession:TTelnetSession):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure EraseCharacter(ASession:TTelnetSession);</code>
|  
|-
| <code>procedure DeleteCharacter(ASession:TTelnetSession);</code>
|  
|-
| <code>procedure InsertCharacter(ASession:TTelnetSession; ACh:Char);</code>
|  
|-
| <code>procedure OverwriteCharacter(ASession:TTelnetSession; ACh:Char);</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure PrevHistory(ASession:TTelnetSession);</code>
|  
|-
| <code>procedure NextHistory(ASession:TTelnetSession);</code>
|  
|-
| <code>procedure CurrentHistory(ASession:TTelnetSession);</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
|-
| <code>procedure TelnetConnected(AConnection:TTelnetConnection);</code>
|  
|-
| <code>procedure TelnetDisconnected(AConnection:TTelnetConnection);</code>
|  
|-
| <code>function TelnetInit(AConnection:TTelnetConnection):Boolean;</code>
|  
|-
| <code>function TelnetChar(AConnection:TTelnetConnection; AChar:Char):Boolean;</code>
|  
|-
| <code>function TelnetCommand(AConnection:TTelnetConnection; ACommand,AOption:Byte; AData:Pointer; ASize:LongWord):Boolean;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>property Listener:TTelnetListener read FListener;</code>
|  
|-
|colspan="2"| 
|-
| <code>function DoClear(ASession:TShellSession):Boolean; override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function DoInput(ASession:TShellSession; var AInput:String):Boolean; override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function DoOutputEx(ASession:TShellSession; const AOutput:String; AReturn:Boolean):Boolean; override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function MatchSequence(const ASequence:String; var AContinue:Boolean):Boolean;</code>
|  
|-
| <code>function ProcessSequence(const ASequence:String):Boolean;</code>
|  
|-
|}
</div></div>
<br />

=== Function declarations ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">constructor TTelnetShell.Create;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">destructor TTelnetShell.Destroy;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.Reset(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.MoveFirst(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Move the cursor to the starting position of the line</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.MoveLast(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.MoveLeft(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Move the cursor one position to the left in the line</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.MoveRight(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Move the cursor one position to the right in the line</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.EraseLine(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Erase all characters in the line and reset the cursor position</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.OutputLine(ASession:TTelnetSession; const AValue:String);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Output all characters in value and update the cursor position</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTelnetShell.ExpandLine(ASession:TTelnetSession):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Expand the tab key to a command completion if available</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.EraseCharacter(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Erase the character to the left of the cursor position</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.DeleteCharacter(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Delete the character to the right of the cursor position</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.InsertCharacter(ASession:TTelnetSession; ACh:Char);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Insert a character at the cursor position</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.OverwriteCharacter(ASession:TTelnetSession; ACh:Char);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Overwrite the character at the cursor position</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.PrevHistory(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the previous command history value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.NextHistory(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the next command history value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.CurrentHistory(ASession:TTelnetSession);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current command history value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.TelnetConnected(AConnection:TTelnetConnection);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTelnetShell.TelnetDisconnected(AConnection:TTelnetConnection);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTelnetShell.TelnetInit(AConnection:TTelnetConnection):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTelnetShell.TelnetChar(AConnection:TTelnetConnection; AChar:Char):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTelnetShell.TelnetCommand(AConnection:TTelnetConnection; ACommand,AOption:Byte; AData:Pointer; ASize:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTelnetShell.DoClear(ASession:TShellSession):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTelnetShell.DoInput(ASession:TShellSession; var AInput:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTelnetShell.DoOutputEx(ASession:TShellSession; const AOutput:String; AReturn:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTelnetShell.MatchSequence(const ASequence:String; var AContinue:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTelnetShell.ProcessSequence(const ASequence:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]