Programmer Guide/Command Reference/SYSTEM - Revision history

Jw at 07:13, 22 October 2018

2018-10-22T07:13:16Z

← Older revision		Revision as of 09:13, 22 October 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	The {{STX}} <code>SYSTEM</code> ~~famili~~ of commands executes Windows system commands. Their <code>SYSTEMCALL</code> variants work like their <code>SYSTEM</code> counterparts, except that they return warnings rather than errors on failure.		The {{STX}} <code>SYSTEM</code> family of commands executes Windows system commands. Their <code>SYSTEMCALL</code> variants work like their <code>SYSTEM</code> counterparts, except that they return warnings rather than errors on failure.

	== <code>SYSTEM</code>: Open the Windows command interpreter ==		== <code>SYSTEM</code>: Open the Windows command interpreter ==

Jw: /* SYSTEM: Open a Windows program or a batch file */

2018-08-07T11:55:20Z

SYSTEM: Open a Windows program or a batch file

← Older revision		Revision as of 13:55, 7 August 2018
Line 22:		Line 22:
	If the <code>SYSTEM</code> family of commands is applied to an executable(.EXE), the respective program is executed directly, i.e., without involving the Windows command interpreter.		If the <code>SYSTEM</code> family of commands is applied to an executable(.EXE), the respective program is executed directly, i.e., without involving the Windows command interpreter.

	For the identification of the Windows command interpreter and for deciding where to look for the programm, the normal settings of the Windows environment are used (<var>COMSPEC</var>, </var>PATH</var>, and so on).		For the identification of the Windows command interpreter and for deciding where to look for the programm, the normal settings of the Windows environment are used (<var>COMSPEC</var>, <var>PATH</var>, and so on).

	== <code>SYSTEM HELP</code>: Accessing HTML help files ==		== <code>SYSTEM HELP</code>: Accessing HTML help files ==

Christian: /* SYSTEM RMDIR: Remove a directory */

2014-04-30T18:31:13Z

SYSTEM RMDIR: Remove a directory

← Older revision		Revision as of 20:31, 30 April 2014
Line 97:		Line 97:
	SYSTEM RMDIR <var>directoryPath</var>		SYSTEM RMDIR <var>directoryPath</var>

	Removes the directory specified by <var>directoryPath</var>. Only the last directory is removed (e.g. if <var>directoryPath</var> is '<code>new1\new2</code>' then only the directory '<code>new2</code>' is removed.		Removes the directory specified by <var>directoryPath</var>. Only the last directory is removed (e.g. if <var>directoryPath</var> is '<code>new1\new2</code>' then only the directory '<code>new2</code>' is removed).

Christian: /* SYSTEM MKDIR: create a directory */

2014-04-30T18:30:21Z

SYSTEM MKDIR: create a directory

← Older revision		Revision as of 20:30, 30 April 2014
Line 73:		Line 73:
	Note that you can use a [[Shell_Items/File_Item/Introducing_File_Items\|shell file item]] to check whether a directory exists.		Note that you can use a [[Shell_Items/File_Item/Introducing_File_Items\|shell file item]] to check whether a directory exists.

	You ~~can~~ retrieve the present working directory with the {{Stx}} command [[Programmer_Guide/Command_Reference/PWD\|<code>PWD</code>]].		You may retrieve the present working directory with the {{Stx}} command [[Programmer_Guide/Command_Reference/PWD\|<code>PWD</code>]].
	system mkdir '\\server1\public\data\output\$#var'		system mkdir '\\server1\public\data\output\$#var'
	system mkdir 'd:\data\output\$#var'		system mkdir 'd:\data\output\$#var'

Christian: /* SYSTEM MKDIR: create a directory */

2014-04-30T18:29:55Z

SYSTEM MKDIR: create a directory

← Older revision		Revision as of 20:29, 30 April 2014
Line 69:		Line 69:
	SYSTEM MKDIR <var>directoryPath</var>		SYSTEM MKDIR <var>directoryPath</var>

	Creates the directory specified by <var>directoryPath</var>. If <var>directoryPath</var> is relative, it is relative to the <~~code~~>@WORK</~~code~~> directory. If ~~multiple~~ directories in <var>directoryPath</var> do not exist, they are all created.		Creates the directory specified by <var>directoryPath</var>. If <var>directoryPath</var> is relative, it is relative to the <var>@WORK</var> directory. If other directories in <var>directoryPath</var> do not exist, they are all created.

	Note that you can use ~~the~~ shell ~~<code>FILE</code>~~ item to check whether a directory exists.		Note that you can use a [[Shell_Items/File_Item/Introducing_File_Items\|shell file item]] to check whether a directory exists.
	You can retrieve the present working directory with the command <code>PWD</code>.~~<pre>~~
	system mkdir '\\server1\public\data\output\$#var'		You can retrieve the present working directory with the {{Stx}} command [[Programmer_Guide/Command_Reference/PWD\|<code>PWD</code>]].
	system mkdir 'd:\data\output\$#var'		system mkdir '\\server1\public\data\output\$#var'
	system mkdir 'output\$#var'		system mkdir 'd:\data\output\$#var'
	~~</pre>~~		system mkdir 'output\$#var'

	== <code>SYSTEM OPEN</code>: Open a document ==		== <code>SYSTEM OPEN</code>: Open a document ==

Christian: /* SYSTEM HELP: Accessing HTML help files */

2014-04-30T14:32:27Z

SYSTEM HELP: Accessing HTML help files

← Older revision		Revision as of 16:32, 30 April 2014
Line 59:		Line 59:

	SYSTEM HELP SEARCH <var>searchString</var> [ <var>helpFile</var> ]		SYSTEM HELP SEARCH <var>searchString</var> [ <var>helpFile</var> ]
	Open up the specified help file, activating the search tab and inserting the search string. Note that the search does not take place. Press return to search. If no help file is specified, the default {{STX}} help file is used (stored in <~~code~~>@HELPFILE</~~code~~>).		Open up the specified help file, activating the search tab and inserting the search string. Note that the search does not take place. Press return to search. If no help file is specified, the default {{STX}} help file is used (stored in <var>@HELPFILE</var>).

	;<var>searchString</var>		;<var>searchString</var>

Christian at 14:31, 30 April 2014

2014-04-30T14:31:16Z

← Older revision		Revision as of 16:31, 30 April 2014
Line 2:		Line 2:
	The {{STX}} <code>SYSTEM</code> famili of commands executes Windows system commands. Their <code>SYSTEMCALL</code> variants work like their <code>SYSTEM</code> counterparts, except that they return warnings rather than errors on failure.		The {{STX}} <code>SYSTEM</code> famili of commands executes Windows system commands. Their <code>SYSTEMCALL</code> variants work like their <code>SYSTEM</code> counterparts, except that they return warnings rather than errors on failure.

	== <code>SYSTEM</code>: ~~Starting~~ the Windows command interpreter ==		== <code>SYSTEM</code>: Open the Windows command interpreter ==

	SYSTEM		SYSTEM
Line 8:		Line 8:
	This will simply start the windows command interpreter.		This will simply start the windows command interpreter.

	== <code>SYSTEM</code>: ~~Starting~~ a Windows program or a batch file ==		== <code>SYSTEM</code>: Open a Windows program or a batch file ==

	SYSTEM <var>command</var> <var>arguments</var>		SYSTEM <var>command</var> <var>arguments</var>

Christian: /* Remove a directory: RMDIR */

2014-04-30T14:29:30Z

Remove a directory: RMDIR

← Older revision		Revision as of 16:29, 30 April 2014
Line 93:		Line 93:
	If there is an error using the <code>OPEN</code> subcommand (e.g. if no application is registered for the document type), the error will ''not'' be reported to {{STX}} nor, in turn, to the macro. This means that it is impossible for an {{Stx}} script to check if the document could be opened.		If there is an error using the <code>OPEN</code> subcommand (e.g. if no application is registered for the document type), the error will ''not'' be reported to {{STX}} nor, in turn, to the macro. This means that it is impossible for an {{Stx}} script to check if the document could be opened.

	==Remove a directory~~: RMDIR~~==		==<code>SYSTEM RMDIR</code>: Remove a directory==

	SYSTEM RMDIR <var>directoryPath</var>		SYSTEM RMDIR <var>directoryPath</var>

	Removes the directory specified by <var>directoryPath</var>. Only the last directory is removed (e.g. if <var>directoryPath</var> is '<code>new1\new2</code>' then only the directory '<code>new2</code>' is removed.		Removes the directory specified by <var>directoryPath</var>. Only the last directory is removed (e.g. if <var>directoryPath</var> is '<code>new1\new2</code>' then only the directory '<code>new2</code>' is removed.

Christian: /* Opening a document */

2014-04-30T14:29:12Z

Opening a document

← Older revision		Revision as of 16:29, 30 April 2014
Line 78:		Line 78:
	</pre>		</pre>

	== ~~Opening~~ a document ==		== <code>SYSTEM OPEN</code>: Open a document ==
	SYSTEM OPEN <var>doc</var>		SYSTEM OPEN <var>doc</var>

Christian: /* Directory creation */

2014-04-30T14:28:56Z

Directory creation

← Older revision		Revision as of 16:28, 30 April 2014
Line 66:		Line 66:
	:The help file to search. If no help file is specified, the help file specified by the user in the {{STX}} Configuration Settings Dialog in the user settings is used.		:The help file to search. If no help file is specified, the help file specified by the user in the {{STX}} Configuration Settings Dialog in the user settings is used.

	== ~~Directory creation~~ ==		== <code>SYSTEM MKDIR</code>: create a directory ==
	SYSTEM MKDIR <var>directoryPath</var>		SYSTEM MKDIR <var>directoryPath</var>

Line 77:		Line 77:
	system mkdir 'output\$#var'		system mkdir 'output\$#var'
	</pre>		</pre>

	== Opening a document ==		== Opening a document ==
	SYSTEM OPEN <var>doc</var>		SYSTEM OPEN <var>doc</var>