This wiki is out of date, use the continuation of this wiki instead

From FenixWiki

Revision as of 11:53, 30 July 2007 (edit) G105b (Talk | contribs) (New page: Category:functions Category:sound ==Definition== '''INT''' unload_song ( <'''INT''' SongID> ) Frees the memory occupied by the song file. == Parameters == {| | '''INT''' SongID...) ← Previous diff		Revision as of 11:55, 31 July 2007 (edit) (undo) Sandman (Talk | contribs) (I think stop_song() is not needed) Next diff →
Line 5:		Line 5:
	'''INT''' unload_song ( <'''INT''' SongID> )		'''INT''' unload_song ( <'''INT''' SongID> )
-	Frees the memory occupied by the song file.	+	Frees the memory occupied by the song file, previously loaded with [[load_song]]().
	== Parameters ==		== Parameters ==
Line 12:		Line 12:
	|}		|}
-	== Notes ==	+	== Returns ==
-	This function frees up the memory occupied by the song file, first loaded with [[load_song]]. Before unloading the song, it is necessary to stop the playback with the function [[stop_song]].	+	'''INT''' : Error.
		+	{|
		+	| -1 || - Error: sound inactive; invalid songID.
		+	|-
		+	| 0 || - No error.
		+	|}

---

Revision as of 11:55, 31 July 2007

Definition

INT unload_song ( <INT SongID> )

Frees the memory occupied by the song file, previously loaded with load_song().

Parameters

INT SongID

- The SongID identifier of the music.

Returns

INT : Error.

-1	- Error: sound inactive; invalid songID.
0	- No error.