TShellCommand

From Ultibo.org
Revision as of 04:05, 29 May 2018 by Ultibo (Talk | contribs) (Created page with "Return to Unit Shell __TOC__ === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible mw-collap...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Return to Unit Shell


Description

To be documented

Class definitions


TShellCommand = class(TListObject)

public
constructor Create;  
destructor Destroy; override;  
private
FManager:TShellManager;  
 
FLock:TCriticalSectionHandle;  
 
FAliases:TLinkedList;  
 
FName:String;  
FHash:LongWord;  
FFlags:LongWord;  
 
function GetName:String;  
procedure SetName(const AName:String);  
procedure SetFlags(AFlags:LongWord);  
protected
function AcquireLock:Boolean;  
function ReleaseLock:Boolean;  
public
property Manager:TShellManager read FManager;  
 
property Name:String read GetName write SetName;  
property Hash:LongWord read FHash;  
property Flags:LongWord read FFlags write SetFlags;  
 
function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; virtual;  
function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; virtual;  
function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; virtual;  
function DoDefault(AShell:TShell; ASession:TShellSession; const AName:String; AParameters:TStrings):Boolean; virtual;  
function DoExtended(AShell:TShell; ASession:TShellSession; const AName:String; AParameters:TStrings):Boolean; virtual;  
 
function DoCompletion(AShell:TShell; ASession:TShellSession; const AName:String; AParameters:TStrings; var AError:Boolean):String; virtual;  
 
function GetAlias(APrevious:TShellAlias; ALock,AUnlock:Boolean):TShellAlias;  
function FindAlias(const AName:String):TShellAlias;  
 
function RegisterAlias(AAlias:TShellAlias):Boolean;  
function DeregisterAlias(AAlias:TShellAlias):Boolean;  
 
function MatchAlias(const AName:String; var AContinue:Boolean):TShellAlias;  


Function declarations


constructor TShellCommand.Create;
Description: To be documented
Note None documented 


destructor TShellCommand.Destroy;
Description: To be documented
Note None documented 


function TShellCommand.GetName:String;
Description: To be documented
Note None documented 


procedure TShellCommand.SetName(const AName:String);
Description: To be documented
Note None documented 


procedure TShellCommand.SetFlags(AFlags:LongWord);
Description: To be documented
Note None documented 


function TShellCommand.AcquireLock:Boolean;
Description: To be documented
Note None documented 


function TShellCommand.ReleaseLock:Boolean;
Description: To be documented
Note None documented 


function TShellCommand.DoHelp(AShell:TShell; ASession:TShellSession):Boolean;
Description: To be documented
Note None documented 


function TShellCommand.DoInfo(AShell:TShell; ASession:TShellSession):Boolean;
Description: To be documented
Note None documented 


function TShellCommand.DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean;
Description: To be documented
Note None documented 


function TShellCommand.DoDefault(AShell:TShell; ASession:TShellSession; const AName:String; AParameters:TStrings):Boolean;
Description: To be documented
Note None documented 


function TShellCommand.DoExtended(AShell:TShell; ASession:TShellSession; const AName:String; AParameters:TStrings):Boolean;
Description: To be documented
Note None documented 


function TShellCommand.DoCompletion(AShell:TShell; ASession:TShellSession; const AName:String; AParameters:TStrings; var AError:Boolean):String;
Description: To be documented
Note None documented 


function TShellCommand.GetAlias(APrevious:TShellAlias; ALock,AUnlock:Boolean):TShellAlias;
Description: To be documented
Note None documented 


function TShellCommand.FindAlias(const AName:String):TShellAlias;
Description: To be documented
Note None documented 


function TShellCommand.RegisterAlias(AAlias:TShellAlias):Boolean;
Description: To be documented
Note None documented 


function TShellCommand.DeregisterAlias(AAlias:TShellAlias):Boolean;
Description: To be documented
Note None documented 


function TShellCommand.MatchAlias(const AName:String; var AContinue:Boolean):TShellAlias;
Description: Check the supplied command name against registered aliases, if matched return alias as result
Name The command name to match
Continued Returns true if more than one alias matches and matching should be retried


Return to Unit Reference

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