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

From STX Wiki
Jump to navigation Jump to search
 
Line 3: Line 3:
 
  UNLOAD SOUNDFILE <var>soundfilePaths</var> [ [[Programmer_Guide/Command_Reference_Options/Silent|/Silent]] ]
 
  UNLOAD SOUNDFILE <var>soundfilePaths</var> [ [[Programmer_Guide/Command_Reference_Options/Silent|/Silent]] ]
  
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.
+
The <code>ULOAD</code> family if {{STX}} commands unloads (hence the name) either the source code of macros (<code>UNLOAD MACROCODE</code>), classes and signal processing units (<code>UNLOAD SPUCODE</code>), or closes at least one sound file.
  
 
;<var>fileName</var>
 
;<var>fileName</var>
Line 10: Line 10:
 
:A blank separated list of paths to soundfiles to unload.
 
:A blank separated list of paths to soundfiles to unload.
 
;<code>/Force</code>
 
;<code>/Force</code>
:Forces the file to be unloaded. This can be useful with classes inheriting from parent classes. Repeat the <code>unload</code> process until all dependencies have been removed.
+
:Forces the file to be unloaded (this makes sense only with <code>MACROCODE</code>, <code>SPUCODE</code> and <code>SOURCECODE</code>). This can be useful with classes inheriting from parent classes. Repeat the <code>unload</code> process until all dependencies have been removed.
 
;<code>/Nolog</code>
 
;<code>/Nolog</code>
 
:If specified, no log message is generated in the {{STx}} log.
 
:If specified, no log message is generated in the {{STx}} log.

Latest revision as of 16:24, 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 (UNLOAD MACROCODE), classes and signal processing units (UNLOAD SPUCODE), 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 makes sense only with MACROCODE, SPUCODE and SOURCECODE). This can be useful with classes inheriting from parent classes. Repeat the unload process 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.