Programmer Guide/Command Reference Options/Silent: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Many S_TOOLS-STx commands support the <code>/Silent</code> option. Where available, this option leads to exceptional situations being reported as warnings instead of errors.
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
Many {{STX}} commands support the <code>/Silent</code>, or <code>/?</code> option, though for some commands it has to be abbreviated as <code>/ilent</code> due to <code>/S</code> already having been used for different purposes. Where available, this option leads to exceptional situations being reported as warnings instead of errors.


Note that there are a few commands where, before introducing the ''silent'' option, the <code>/S</code> flag had already been assigned to a different option. In order not to break existing user code, for the respective commands, the ''silent'' flag is indicated by a different letter (e.g. <code>/L</code> for the [[Programmer_Guide/Command_Reference/LOAD|LOAD]] command). We apologize for the inconvenience.
Warnings are the same value as the error code, with 32768 added to them. E.g. the error code 282 ("cannot load XML file (no reason given)") has the warning code 33050 (282+32768). This is essential, when checking for error codes in conjunction with the silent flag.
 
Notes:
* There are a few commands where, before introducing the ''silent'' option, the <code>/S</code> flag had already been assigned to a different option. In order not to break existing user code, for the respective commands, the ''silent'' flag is indicated by a different letter (e.g. <code>/Lisent</code> for the [[Programmer_Guide/Command_Reference/LOAD|LOAD]] command or <code>/Ilsent</code> for the {{Stx}} command [[Programmer_Guide/Command_Reference/NEW|NEW]]).
* Since {{STx}} version 4.0 the general flag <code>/?</code> can be used to specifiy the ''silent'' option. This general flag was implemeted to simplify script programming and to increase orthogonality - at least in this respect.
<!-- C.G. 15.3.2011 -->

Latest revision as of 08:19, 16 September 2019

Many STx commands support the /Silent, or /? option, though for some commands it has to be abbreviated as /ilent due to /S already having been used for different purposes. Where available, this option leads to exceptional situations being reported as warnings instead of errors.

Warnings are the same value as the error code, with 32768 added to them. E.g. the error code 282 ("cannot load XML file (no reason given)") has the warning code 33050 (282+32768). This is essential, when checking for error codes in conjunction with the silent flag.

Notes:

  • There are a few commands where, before introducing the silent option, the /S flag had already been assigned to a different option. In order not to break existing user code, for the respective commands, the silent flag is indicated by a different letter (e.g. /Lisent for the LOAD command or /Ilsent for the STx command NEW).
  • Since STx version 4.0 the general flag /? can be used to specifiy the silent option. This general flag was implemeted to simplify script programming and to increase orthogonality - at least in this respect.

Navigation menu

Personal tools