Sage-ST

Sage-ST ä
Cmndline
Documentation


  procedure GetCommandField
             (fieldNumber : in     ModSys.S_Natural;
              fieldValue  : in out string;
              done        : in out boolean);

  --*
  --  GetCommandField - Get the specified command field.
  --
  --
  --  This procedure retrieves the requested field from the
  --  command line.  Delimiters between fields may be
  --  blanks, commas (,), or equal signs (=).
  --
  --  CALLING SEQUENCE -
  --
  --    GetCommandField (FieldNumber, fieldValue, done)
  --
  --  ENTRY -
  --
  --    fieldNumber : Modsys.S_Natural
  --      Field number within command line (1..n).  The first field typed on
  --      the execution line is field 0 and does not appear in the command line.
  --      For example, the following execution line may be used
  --
  --        M2 SAMPLE
  --
  --      The fieldValue, 'SAMPLE', would be value 1 of the line.  'M2" would
  --      not be available.
  --
  --  EXIT -
  --
  --    fieldValue : string
  --      Value of the requested field.
  --
  --    done : boolean
  --      Requested field value was available, returned in 'fieldValue' variable.
  --


  procedure GetCommandLine
             (command : in out string);

  --*
  --  GetCommandLine - Get the execution line.
  --
  --
  --  This procedure returns the command execution line.
  --
  --  CALLING SEQUENCE -
  --
  --    GetCommandLine (command);
  --
  --  EXIT -
  --
  --    command : string
  --      Array containing command line parameters.
  --
  --    NOTE - If the command parameter array is not large enough a null string will
  --           be returned.
  --
  --  EXAMPLE -
  --
  --    line : string (1..128);
  --
  --    begin
  --      GetCommandLine (line);
  --


  procedure GetCommandPair
             (fieldNumber : in     ModSys.S_Natural;
              command     : in out string;
              fieldValue  : in out string;
              done        : in out boolean);

  --*
  --  GetCommandPair - Get the specified command pair.
  --
  --
  --  This procedure retrieves the requested command pair from the
  --  command line.  Delimiters between fields may be blanks or
  --  commas (,).  Command pairs must be separated by an equals(=)
  --  sign.  No spaces are allowed on either side of the pair
  --  separator.
  --
  --  example -
  --
  --    PROGRAM PATH=c:\batch PW=SAMPLE
  --
  --  CALLING SEQUENCE -
  --
  --    GetCommandPair (FieldNumber, command, fieldValue, done);
  --
  --  ENTRY -
  --
  --    FieldNumber : Modsys.S_Natural
  --      Field number within the command line (1..n).  See GetCommandField.
  --
  --  EXIT -
  --
  --    command : string
  --      Value of first component of the command pair.
  --
  --    fieldValue : string
  --      Value of the second component of the command pair.
  --
  --    done : boolean
  --      Returns TRUE if desired command pair was located.
  --


  procedure GetDirective
             (intro : in     string;
              Value : in out string;
              done  : in out boolean);

  --*
  --  GetDirective - Get the specified command field value.
  --
  --
  --  This procedure searches for a specific first component
  --  of a command pair. If found, it will return the corresponding
  --  component of the pair.  If not found, a null string will be
  --  returned.
  --
  --  CALLING SEQUENCE -
  --
  --    GetDirective (intro, value, done)
  --
  --  ENTRY -
  --
  --    intro : string
  --      Array containing search criteria for pairs.
  --
  --  EXIT -
  --
  --    value : string
  --      Value of the requested field.
  --
  --    done : boolean
  --      flag that shows whether "intro" was located in command line.
  --
  --  EXAMPLE -
  --
  --    input_file : string (1..32);
  --    done : boolean;
  --
  --    begin
  --      GetDirective ("INPUT",input_file,done);
  --