Previous Topic Index Next Topic
[API function]

FSOUND_StopSound

Stops a specified sound channel from playing, and frees it up for re-use.

signed char F_API FSOUND_StopSound(
int channel
);

Parameters

channel The channel number/handle to stop. FSOUND_ALL can also be used (see remarks)

Return Value

On success, TRUE is returned.
On failure, FALSE is returned.

Remarks

FSOUND_ALL is supported. Passing this will cause ALL channels to stop.
If FSOUND_ALL is used the last channel success flag will be returned. This return value is not useful in most circumstances.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

See Also

FSOUND_PlaySound , FSOUND_PlaySoundEx

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:35 2005 by SourceDoc v0.10, the automated source code documenter.