View source for Unit ShellFilesystem

Return to [[Unit_Reference|Unit Reference]]


=== Description ===
----

'''Ultibo FileSystem Shell extension unit'''

=== Constants ===
----


<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Shell FileSystem command''' <code> SHELL_FILESYS_COMMAND_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>SHELL_FILESYS_COMMAND_FILESYSTEM = 'FILESYSTEM';</code>
| style="width: 50%;"|&nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_CONTROLLER = 'CONTROLLER';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_DISK = 'DISK';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_PARTITION = 'PARTITION';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_VOLUME = 'VOLUME';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_DRIVE = 'DRIVE';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_CACHE = 'CACHE';</code>
| &nbsp;
|-
|colspan="2"|&nbsp; 
|-
| <code>SHELL_FILESYS_COMMAND_DIR = 'DIR';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_CHDIR = 'CD';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_MKDIR = 'MD';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_RMDIR = 'RD';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_TYPE = 'TYPE';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_COPY = 'COPY';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_MOVE = 'MOVE';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_DEL = 'DEL';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_REN = 'REN';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_ATTRIB = 'ATTRIB';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_TOUCH = 'TOUCH';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_VOL = 'VOL';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_LABEL = 'LABEL';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_DELTREE = 'DELTREE';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_COMMAND_XCOPY = 'XCOPY';</code>
| &nbsp;
|-
|}
</div></div>
<br /> 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Shell FileSystem alias''' <code> SHELL_FILESYS_ALIAS_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>SHELL_FILESYS_ALIAS_LS = 'LS';</code>
| style="width: 50%;"|&nbsp;
|-
| <code>SHELL_FILESYS_ALIAS_CD = 'CHDIR';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ALIAS_CDSLASH = 'CD\';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ALIAS_CDDOTDOT = 'CD..';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ALIAS_MD = 'MKDIR';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ALIAS_RD = 'RMDIR';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ALIAS_RM = 'RM';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ALIAS_DELETE = 'DELETE';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ALIAS_ERASE = 'ERASE';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ALIAS_RENAME = 'RENAME';</code>
| &nbsp;
|-
|}
</div></div>
<br /> 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Shell FileSystem action''' <code> SHELL_FILESYS_ACTION_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>SHELL_FILESYS_ACTION_LIST = 'LIST';</code>
| style="width: 50%;"|&nbsp;
|-
| <code>SHELL_FILESYS_ACTION_SHOW = 'SHOW';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_ACTION_LABEL = 'LABEL';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_FILL = 'FILL';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_SIGNATURE = 'SIGNATURE';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_INITIALIZE = 'INITIALIZE';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_ACTION_EJECT = 'EJECT';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_LOCK = 'LOCK';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_UNLOCK = 'UNLOCK';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_ACTION_ADD = 'ADD';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_DELETE = 'DELETE';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_ACTIVATE = 'ACTIVATE';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_DEACTIVATE = 'DEACTIVATE';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_ACTION_FORMAT = 'FORMAT';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_DEFRAG = 'DEFRAG';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_CHECK = 'CHECK';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_CLEAN = 'CLEAN';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_DIRTY = 'DIRTY';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_MOUNT = 'MOUNT';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_DISMOUNT = 'DISMOUNT';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_ACTION_STATS = 'STATS';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_FLUSH = 'FLUSH';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_DISCARD = 'DISCARD';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_ACTION_START = 'START';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_ACTION_STOP = 'STOP';</code>
| &nbsp;
|-
|}
</div></div>
<br /> 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Shell FileSystem parameter''' <code> SHELL_FILESYS_PARAMETER_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>SHELL_FILESYS_PARAMETER_HELP = '?';</code>
| style="width: 50%;"|&nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_PAGE = 'P';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_SHORT = 'X';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_SUBDIR = 'S';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_OVERWRITE = 'O';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_READONLY = '+R';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_ARCHIVE = '+A';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_SYSTEM = '+S';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_HIDDEN = '+H';</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_NOTREADONLY = '-R';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_NOTARCHIVE = '-A';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_NOTSYSTEM = '-S';</code>
| &nbsp;
|-
| <code>SHELL_FILESYS_PARAMETER_NOTHIDDEN = '-H';</code>
| &nbsp;
|-
|}
</div></div>
<br /> 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Shell FileSystem mask''' <code> SHELL_FILESYS_*_MASK </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>SHELL_FILESYS_ALLFILES_MASK = '*.*';</code>
| style="width: 50%;"|&nbsp;
|-
|}
</div></div>
<br />

=== Type definitions ===
----

''None defined''

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


'''Shell FileSystem specific classes'''

{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysFileSystem|<code>TShellFileSysFileSystem = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysController|<code>TShellFileSysController = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysDisk|<code>TShellFileSysDisk = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysPartition|<code>TShellFileSysPartition = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysVolume|<code>TShellFileSysVolume = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysDrive|<code>TShellFileSysDrive = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysCache|<code>TShellFileSysCache = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysDir|<code>TShellFileSysDir = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysChdir|<code>TShellFileSysChdir = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysMkdir|<code>TShellFileSysMkdir = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysRmdir|<code>TShellFileSysRmdir = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysType|<code>TShellFileSysType = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysCopy|<code>TShellFileSysCopy = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysMove|<code>TShellFileSysMove = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysDel|<code>TShellFileSysDel = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysRen|<code>TShellFileSysRen = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysAttrib|<code>TShellFileSysAttrib = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysTouch|<code>TShellFileSysTouch = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysVol|<code>TShellFileSysVol = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysLabel|<code>TShellFileSysLabel = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysDeltree|<code>TShellFileSysDeltree = class(TShellCommand)</code>]]
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| [[TShellFileSysXcopy|<code>TShellFileSysXcopy = class(TShellCommand)</code>]]
|-
|}
<br />

=== Public variables ===
----

''None defined''

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


'''Initialization functions'''

<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 ShellFileSysInit;</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]]