Sage-ST ä

Cmndline

Documentation

GetCommandField GetCommandLine GetCommandPair GetDirective
STRGetCommandField STRGetCommandLine STRGetCommandPair STRGetDirective
STRSetCommandLine SetCommandLine




  procedure GetCommandLine
             (var   command : array of char); overload; stdcall;

  exports GetCommandLine (var   command : array of char) name 'CmndLine_GetCommandLine';

  //*
  //  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 GetCommandLine
             (var   command : string); overload; stdcall;

  exports GetCommandLine (var   command : string) name 'CmndLine_STRGetCommandLine';

  //*
  //  STRGetCommandLine - See documentation of GetCommandLine.
  //




  procedure SetCommandLine
             (var   command : array of char); overload; stdcall;

  exports SetCommandLine (var   command : array of char) name 'CmndLine_SetCommandLine';

  //*
  //  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 SetCommandLine
             (var   command : string); overload; stdcall;

  exports SetCommandLine (var   command : string) name 'CmndLine_STRSetCommandLine';

  //*
  //  STRSetCommandLine - See documentation of SetCommandLine.
  //




  procedure GetCommandField
             (const fieldNumber : cardinal;
              var   fieldValue  : array of char;
              var   done        : boolean); overload; stdcall;

  exports GetCommandField (const fieldNumber : cardinal;
                           var   fieldValue  : array of char;
                           var   done        : boolean) name 'CmndLine_GetCommandField';

  //*
  //  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 GetCommandField
             (const fieldNumber : cardinal;
              var   fieldValue  : string;
              var   done        : boolean); overload; stdcall;

  exports GetCommandField (const fieldNumber : cardinal;
                           var   fieldValue  : string;
                           var   done        : boolean) name 'CmndLine_STRGetCommandField';

  //*
  //  STRGetCommandField - See documentation of GetCommandField.
  //




  procedure GetCommandPair
             (const fieldNumber : cardinal;
              var   command     : array of char;
              var   fieldValue  : array of char;
              var   done        : boolean); overload; stdcall;

  exports GetCommandPair (const fieldNumber : cardinal;
                          var   command     : array of char;
                          var   fieldValue  : array of char;
                          var   done        : boolean) name 'CmndLine_GetCommandPair';

  //*
  //  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 GetCommandPair
             (const fieldNumber : cardinal;
              var   command     : string;
              var   fieldValue  : string;
              var   done        : boolean); overload; stdcall;

  exports GetCommandPair (const fieldNumber : cardinal;
                          var   command     : string;
                          var   fieldValue  : string;
                          var   done        : boolean) name 'CmndLine_STRGetCommandPair';

  //*
  //  STRGetCommandPair - See documentation of GetCommandPair.
  //




  procedure GetDirective
             (const intro : array of char;
              var   Value : array of char;
              var   done  : boolean); overload; stdcall;

  exports GetDirective (const intro : array of char;
                        var   Value : array of char;
                        var   done  : boolean) name 'CmndLine_GetDirective';

  //*
  //  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.
  //




  procedure GetDirective
             (const intro : string;
              var   Value : array of char;
              var   done  : boolean); overload; stdcall;

  exports GetDirective (const intro : string;
                        var   Value : array of char;
                        var   done  : boolean) name 'CmndLine_STRGetDirective';

  //*
  //  STRGetDirective - See documentation of GetDirective.
  //




Send mail to   warren.merrill@inl.gov with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance