Sage-ST

Sage-ST ä
Cmndline
Documentation

GetCommandField	GetCommandLine	GetCommandPair	GetDirective
SetCommandLine


  PROCEDURE GetCommandLine
             (VAR   command : ARRAY OF CHAR);

  (**
      GetCommandLine - Get the execution line.


      This procedure returns the command execution line.

      CALLING SEQUENCE -

        GetCommandLine (command);

      EXIT -

        command : ARRAY OF CHAR
          Array containing command line parameters.

          NOTE - If the command parameter array is not large enough a null
                 string will be returned.
  *)


  PROCEDURE SetCommandLine
             (VAR   command : ARRAY OF CHAR);

  (**
      SetCommandLine - Set the execution line.


      This procedure sets the command execution line.

      CALLING SEQUENCE -

        SetCommandLine (command);

      ENTRY -

        command : ARRAY OF CHAR
          Array containing command line parameters.
  *)


  PROCEDURE GetCommandField
             (CONST fieldNumber : CARDINAL;
              VAR   fieldValue  : ARRAY OF CHAR;
              VAR   done        : BOOLEAN);

  (**
      GetCommandField - Get the specified command field.


      This procedure retrieves the requested field from the
      command line.  Delimeters between fields may be
      blanks, commas (, ), or equal signs (=).

      CALLING SEQUENCE -

        GetCommandField (fieldNumber, fieldValue)

      ENTRY -

        fieldNumber : CARDINAL
          Field number within the command line (1 .. n).  The
                  first field typed in for 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
                  and 'M2' would not be available.

      EXIT -

        fieldValue : ARRAY OF CHAR
          Value of the requested field.

        done : BOOLEAN
          The requested field value was available and returned
          in the 'fieldValue' variable.
  *)


  PROCEDURE GetCommandPair
             (CONST fieldNumber : CARDINAL;
              VAR   command     : ARRAY OF CHAR;
              VAR   fieldValue  : ARRAY OF CHAR;
              VAR   done        : 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.

      CALLING SEQUENCE -

        GetCommandPair (fieldNumber, command, fieldValue, gotIt);

      ENTRY -

        fieldNumber : CARDINAL
          Field number within the command line (1 .. n). For an example
          reference GetCommandField Documation.

      EXIT -

        command : ARRAY OF CHAR
          Value of first component of the command pair.

        fieldValue : ARRAY OF CHAR
          Value of the second component of the command pair.

        gotIt : BOOLEAN
          Returns TRUE if desired command pair was located.
  *)


  PROCEDURE GetDirective
             (CONST intro : ARRAY OF CHAR;
              VAR   Value : ARRAY OF CHAR;
              VAR   done  : 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 none is there a null string will be
      returned.

      CALLING SEQUENCE -

        GetDirective (intro, value, done)

      ENTRY -

        intro : ARRAY OF CHAR
          Array containing search criteria for pairs.

      EXIT -

        fieldValue : ARRAY OF CHAR
          Value of the requested field.

        done : BOOLEAN
          flag that shows whether "intro" was located in command line.
  *)