Difference between revisions of "Programmer Guide/Command Reference/UNLOAD"

From STX Wiki
Jump to navigation Jump to search
m (1 revision: Initial import)
Line 1: Line 1:
 
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
 
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==UNLOAD==
+
UNLOAD MACROCODE|SPUCODE|SOURCECODE <var>fileName</var> [ /Force ] [ /Nolog ][ [[Programmer_Guide/Command_Reference_Options/Silent|/Silent]] ]
 +
UNLOAD SOUNDFILE <var>soundfilePaths</var> [ [[Programmer_Guide/Command_Reference_Options/Silent|/Silent]] ]
  
<code>UNLOAD MACROCODE|SPUCODE|SOURCECODE <var>fileName</var> [ /Force ] [ /Nolog ][ /S ]</code>
+
The <code>ULOAD</code> family if {{STX}} commands unloads (hence the name) either the source code of macros, classes and signal processing units, or closes at least one sound file.
 
 
<code>UNLOAD SOUNDFILE <var>soundfilePaths</var> [ /S ]</code>
 
 
 
Unload source code of macros, classes and signal processing units or close sound files.
 
  
 
;<var>fileName</var>
 
;<var>fileName</var>
 
+
:The name of the {{Stx}} sourcecode file to unload.
:The name of the sourcecode file to unload.
 
 
 
 
;<var>soundfilePaths</var>
 
;<var>soundfilePaths</var>
 +
:A blank separated list of paths to soundfiles to unload.
 +
;<code>/Force</code>
 +
:Forces the file to be unloaded. This can be useful with classes inheriting from parent classes. Repeat the <code>unload</command> until all dependencies have been removed.
 +
;<code>/Nolog</code>
 +
:If specified, no log message is generated in the {{STx}} log.
 +
;<code>[[Programmer_Guide/Command_Reference_Options/Silent|/Silent]]</code>
 +
:If specified, errors will generate warning messages rather than error messages. See [[Programmer_Guide/Command_Reference_Options/Silent|The Silent Flag]] for details.
  
:A blank separated list of sound file paths to unload.
+
Quite obviously, source code can only be unloaded if it is not being used.
 
 
;<var>/Force</var>
 
 
 
:Forces the file to be unloaded. This can be useful in conjunction with classes, which inherit from parent classes. Repeat unload until all dependencies have been removed.
 
 
 
;<var>/Nolog</var>
 
 
 
:If specified, no log message is generated in the Log log.
 
 
 
;<var>/S</var>
 
 
 
:If specified, errors will generate warning messages rather than error messages. See The Silent Flag for details.
 
 
 
Source code can only be unloaded if it is not in use!
 

Revision as of 16:21, 7 May 2014

UNLOAD MACROCODE|SPUCODE|SOURCECODE fileName [ /Force ] [ /Nolog ][ /Silent ]
UNLOAD SOUNDFILE soundfilePaths [ /Silent ]

The ULOAD family if STx commands unloads (hence the name) either the source code of macros, classes and signal processing units, or closes at least one sound file.

fileName
The name of the STx sourcecode file to unload.
soundfilePaths
A blank separated list of paths to soundfiles to unload.
/Force
Forces the file to be unloaded. This can be useful with classes inheriting from parent classes. Repeat the unload</command> until all dependencies have been removed.
/Nolog
If specified, no log message is generated in the STx log.
/Silent
If specified, errors will generate warning messages rather than error messages. See The Silent Flag for details.

Quite obviously, source code can only be unloaded if it is not being used.