Difference between revisions of "TShellSession"
From Ultibo.org
								
												
				 (Created page with "Return to Unit Shell   __TOC__  === Description === ----  ''To be documented''  === Class definitions === ----   <div class="toccolours mw-collapsible mw-collap...")  | 
			
(No difference) 
 | 
Latest revision as of 04:04, 29 May 2018
Return to Unit Shell
Description
To be documented
Class definitions
TShellSession = class(TListObject)
public 
 | |
 constructor Create(AShell:TShell; AIdentifier:LongWord);
 | 
|
 destructor Destroy; override;
 | 
|
private 
 | |
 FShell:TShell;
 | 
|
 FLock:TCriticalSectionHandle; 
 | 
|
 FIdentifier:LongWord;
 | 
Unique identifier for this session | 
 FFlags:LongWord;
 | 
|
 FPrompt:String;
 | 
Current prompt for this session | 
 FData:Pointer;
 | 
Shell private data for this session | 
 FHistories:TLinkedObjList;
 | 
|
 FCurrentHistory:TShellHistory;
 | 
|
 procedure SetFlags(AFlags:LongWord);
 | 
|
 procedure SetData(AData:Pointer);
 | 
|
 function GetPrompt:String;
 | 
|
 procedure SetPrompt(const APrompt:String);
 | 
|
protected 
 | |
 function AcquireLock:Boolean;
 | 
|
 function ReleaseLock:Boolean;
 | 
|
public 
 | |
 property Shell:TShell read FShell;
 | 
|
 property Identifier:LongWord read FIdentifier;
 | 
|
 property Flags:LongWord read FFlags write SetFlags;
 | 
|
 property Prompt:String read GetPrompt write SetPrompt;
 | 
|
 property Data:Pointer read FData write SetData;
 | 
|
 function AddHistory(const ACommand:String):Boolean;
 | 
|
 procedure ClearHistory;
 | 
|
 function FirstHistory:String;
 | 
|
 function LastHistory:String;
 | 
|
 function NextHistory:String;
 | 
|
 function PrevHistory:String;
 | 
|
 function CurrentHistory:String;
 | 
|
Function declarations
constructor TShellSession.Create(AShell:TShell; AIdentifier:LongWord);
Description: To be documented
| Note | None documented | 
|---|
 
destructor TShellSession.Destroy;
Description: To be documented
| Note | None documented | 
|---|
procedure TShellSession.SetFlags(AFlags:LongWord);
Description: To be documented
| Note | None documented | 
|---|
procedure TShellSession.SetData(AData:Pointer);
Description: To be documented
| Note | None documented | 
|---|
function TShellSession.GetPrompt:String;
Description: To be documented
| Note | None documented | 
|---|
procedure TShellSession.SetPrompt(const APrompt:String);
Description: To be documented
| Note | None documented | 
|---|
function TShellSession.AcquireLock:Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TShellSession.ReleaseLock:Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TShellSession.AddHistory(const ACommand:String):Boolean;
Description: To be documented
| Note | None documented | 
|---|
procedure TShellSession.ClearHistory;
Description: To be documented
| Note | None documented | 
|---|
function TShellSession.FirstHistory:String;
Description: To be documented
| Note | None documented | 
|---|
function TShellSession.LastHistory:String;
Description: To be documented
| Note | None documented | 
|---|
function TShellSession.NextHistory:String;
Description: To be documented
| Note | None documented | 
|---|
function TShellSession.PrevHistory:String;
Description: To be documented
| Note | None documented | 
|---|
function TShellSession.CurrentHistory:String;
Description: To be documented
| Note | None documented | 
|---|
Return to Unit Reference