OzCIS Script Language Pre-defined Variables


By Name

variable     category  summary
-----------  --------  ------------------------------------------------------------
%ARGx        Script    Xth command line argument passed to a script when executed
%COMDATA     Variable  current line of data from the serial port
%CR          Constant  defined as ^M
%DATE        Variable  current date in dd-mmm-yy format
%DLPATH      Host      full pathname of the current general download path
%FALSE       Constant  defined as 0, useful for true/false tests
%FORUMPATH   Forum     full pathname of the current or most recent forum
%FORUMWORD   Forum     current or most recent forum's GO word
%GIFPATH     Host      full pathname of the current GIF download path
%HOSTBAUD    Host      current baud rate
%HOSTNAME    Host      name of the current host
%HOSTNUM     Host      number of the host in the Hosts List
%HOSTPATH    Host      full pathname of the currently selected host
%HOSTPORT    Host      number of the host's comm port
%LCOMDATA    Variable  previous line of data from the serial port
%ONLINE      Variable  %TRUE when OzCIS is logged on to CIS, otherwise %FALSE
%PROMPTCHAR  Forum     current prompt character
%SCRIPTNAME  Script    full path and filename of the currently executing script
%SLASH       Variable  returns a slash char (/) when needed for the current command
%TIME        Variable  current time in hh:mm:ss format
%TRUE        Constant  defined as 1, useful for true/false tests
%USERID      User      current user ID
%USERNAME    User      current user name from the Host config
%USERPWRD    User      current user password


By Category

category  variable     type
--------  -----------  -------
Constant  %CR          String
Constant  %FALSE       Boolean
Constant  %TRUE        Boolean

Forum     %FORUMPATH   String
Forum     %FORUMWORD   String
Forum     %PROMPTCHAR  String

Host      %DLPATH      String
Host      %GIFPATH     String
Host      %HOSTBAUD    Numeric
Host      %HOSTNAME    String
Host      %HOSTNUM     Numeric
Host      %HOSTPATH    String
Host      %HOSTPORT    Numeric

Script    %ARGx        General
Script    %SCRIPTNAME  String

User      %USERID      String
User      %USERNAME    String
User      %USERPWRD    String

Variable  %COMDATA     String
Variable  %DATE        String
Variable  %LCOMDATA    String
Variable  %ONLINE      Boolean
Variable  %SLASH       String
Variable  %TIME        String


By Type

type     variable     category
-------  -----------  --------
Boolean  %FALSE       Constant
Boolean  %ONLINE      Variable
Boolean  %TRUE        Constant

General  %ARGx        Script

Numeric  %HOSTBAUD    Host
Numeric  %HOSTNUM     Host
Numeric  %HOSTPORT    Host

String   %COMDATA     Variable
String   %CR          Constant
String   %DATE        Variable
String   %DLPATH      Host
String   %FORUMPATH   Forum
String   %FORUMWORD   Forum
String   %GIFPATH     Host
String   %HOSTNAME    Host
String   %HOSTPATH    Host
String   %LCOMDATA    Variable
String   %PROMPTCHAR  Forum
String   %SCRIPTNAME  Script
String   %SLASH       Variable
String   %TIME        Variable
String   %USERID      User
String   %USERNAME    User
String   %USERPWRD    User