Difference between revisions of "TShell"

From Ultibo.org
Jump to: navigation, search
 
Line 142: Line 142:
 
|-
 
|-
 
| <code>property Flags:LongWord read FFlags write SetFlags;</code>
 
| <code>property Flags:LongWord read FFlags write SetFlags;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function DoReset(ASession:TShellSession):Boolean; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 487: Line 492:
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<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 TShell.ReleaseLock:Boolean;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function TShell.ReleaseLock: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 TShell.DoReset(ASession:TShellSession):Boolean;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<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;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">

Latest revision as of 00:32, 14 December 2018

Return to Unit Shell


Description

To be documented

Class definitions


[Expand]

TShell = class(TListObject)


Function declarations


[Expand] 
constructor TShell.Create;
Description: To be documented


[Expand] 
destructor TShell.Destroy;
Description: To be documented


[Expand] 
procedure TShell.SetAuthenticator(AAuthenticator:TAuthenticator);
Description: To be documented


[Expand] 
function TShell.GetBanner:String;
Description: To be documented


[Expand] 
procedure TShell.SetBanner(const ABanner:String);
Description: To be documented


[Expand] 
function TShell.GetPrompt:String;
Description: To be documented


[Expand] 
procedure TShell.SetPrompt(const APrompt:String);
Description: To be documented


[Expand] 
function TShell.GetError:String;
Description: To be documented


[Expand] 
procedure TShell.SetError(const AError:String);
Description: To be documented


[Expand] 
function TShell.GetName:String;
Description: To be documented


[Expand] 
procedure TShell.SetName(const AName:String);
Description: To be documented


[Expand] 
procedure TShell.SetFlags(AFlags:LongWord);
Description: To be documented


[Expand] 
function TShell.AcquireLock:Boolean;
Description: To be documented


[Expand] 
function TShell.ReleaseLock:Boolean;
Description: To be documented


[Expand] 
function TShell.DoReset(ASession:TShellSession):Boolean;
Description: To be documented


[Expand] 
function TShell.DoClear(ASession:TShellSession):Boolean;
Description: To be documented


[Expand] 
function TShell.DoBanner(ASession:TShellSession):Boolean;
Description: To be documented


[Expand] 
function TShell.DoPrompt(ASession:TShellSession):Boolean;
Description: To be documented


[Expand] 
function TShell.DoError(ASession:TShellSession):Boolean;
Description: To be documented


[Expand] 
function TShell.DoInput(ASession:TShellSession; var AInput:String):Boolean;
Description: To be documented


[Expand] 
function TShell.DoOutput(ASession:TShellSession; const AOutput:String):Boolean;
Description: To be documented


[Expand] 
function TShell.DoOutputEx(ASession:TShellSession; const AOutput:String; AReturn:Boolean):Boolean;
Description: To be documented


[Expand] 
function TShell.DoGetSize(ASession:TShellSession; var ARows,ACols:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoSetSize(ASession:TShellSession; ARows,ACols:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoGetCursor(ASession:TShellSession; var ARow,ACol:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoSetCursor(ASession:TShellSession; ARow,ACol:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoGetColors(ASession:TShellSession; var AForecolor,ABackcolor:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoSetColors(ASession:TShellSession; AForecolor,ABackcolor:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoGetCoordinates(ASession:TShellSession; var ARow,ACol:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoSetCoordinates(ASession:TShellSession; ARow,ACol:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoGetCursorMode(ASession:TShellSession; var AMode:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoSetCursorMode(ASession:TShellSession; AMode:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoGetCursorShape(ASession:TShellSession; var AShape:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.DoSetCursorShape(ASession:TShellSession; AShape:LongWord):Boolean;
Description: To be documented


[Expand] 
function TShell.GetSession(APrevious:TShellSession; ALock,AUnlock:Boolean):TShellSession;
Description: To be documented


[Expand] 
function TShell.FindSession(AIdentifier:LongWord):TShellSession;
Description: To be documented


[Expand] 
function TShell.CreateSession(AIdentifier:LongWord):TShellSession;
Description: To be documented


[Expand] 
function TShell.DestroySession(ASession:TShellSession):Boolean;
Description: To be documented


[Expand] 
function TShell.RegisterSession(ASession:TShellSession):Boolean;
Description: To be documented


[Expand] 
function TShell.DeregisterSession(ASession:TShellSession):Boolean;
Description: To be documented


[Expand] 
function TShell.GetCommand(APrevious:TShellCommand; ALock,AUnlock:Boolean):TShellCommand;
Description: To be documented


[Expand] 
function TShell.FindCommand(const AName:String):TShellCommand;
Description: To be documented


[Expand] 
function TShell.DefaultCommand:TShellCommand;
Description: To be documented


[Expand] 
function TShell.RegisterCommand(ACommand:TShellCommand):Boolean;
Description: To be documented


[Expand] 
function TShell.DeregisterCommand(ACommand:TShellCommand):Boolean;
Description: To be documented


[Expand] 
function TShell.MatchCommand(const ACommand:String; var AName:String; var AParameters:TStrings; var AContinue:Boolean):TShellCommand;
Description: Check the supplied command against registered commands, if matched return command as result


[Expand] 
function TShell.CompleteCommand(ASession:TShellSession; const ACommand:String; var AError:Boolean):String;
Description: Attempt to complete the supplied command by matching an existing command and performing command completion


[Expand] 
function TShell.ProcessCommand(ASession:TShellSession; const ACommand:String):Boolean;
Description: Process the supplied command against the registered commands


[Expand] 
function TShell.CommandName(const ACommand:String):String;
Description: Extract the command name from the command line


[Expand] 
function TShell.CommandSplit(const ACommand:String):TStrings;
Description: Split the command line into individual parameters


[Expand] 
function TShell.CommandJoin(AParameters:TStrings):String;
Description: Join the individual parameters into a command line


[Expand] 
function TShell.CommandParse(const ACommand:String; var AName:String; var AParameters:TStrings):Boolean;
Description: Parse the command line into the command name and parameters


[Expand] 
function TShell.CommandConcat(const AName:String; AParameters:TStrings):String;
Description: Concatenate the command name and parameters into a command line


[Expand] 
function TShell.CommandIndex(AIndex:Integer; const ACommand:String):String;
Description: Return the command line parameter specified by Index (0 is the command name, 1 is the first parameter etc)


[Expand] 
function TShell.ParameterIndex(AIndex:Integer; AParameters:TStrings):String;
Description: Return the command line parameter specified by Index (0 is the first parameter, 1 is the second etc)


[Expand] 
function TShell.ParameterValue(const AParameter:String; AParameters:TStrings):String;
Description: To be documented


[Expand] 
function TShell.ParameterExists(const AParameter:String; AParameters:TStrings):Boolean;
Description: To be documented


[Expand] 
function TShell.ParameterValueEx(const AParameter:String; AParameters:TStrings; APlus,AMinus:Boolean):String;
Description: Return the value of the command line parameter specified by Parameter


[Expand] 
function TShell.ParameterExistsEx(const AParameter:String; AParameters:TStrings; APlus,AMinus:Boolean):Boolean;
Description: Check for the existence of the command line parameter specified by Parameter


[Expand] 
function TShell.AddOutput(var AOutput:String; ACol:LongWord; const AValue:String):Boolean;
Description: To be documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=TShell&oldid=4589"