Previous Topic Index Next Topic
[API function]

FSOUND_Stream_Close

Shuts down and releases an FSOUND stream.

signed char F_API FSOUND_Stream_Close(
FSOUND_STREAM *stream
);

Parameters

stream Pointer to the stream to be closed down.

Return Value

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

Remarks

If the stream has been opened with FSOUND_NONBLOCKING, this function will not succeed until the stream is ready.
The only exception to this rule is for internet streams - this function will successfully close an internet stream that has been opened with FSOUND_NONBLOCKING before that stream is ready.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

See Also

FSOUND_Stream_Create , FSOUND_Stream_Net_GetBufferProperties , FSOUND_Stream_Net_GetLastServerStatus , FSOUND_Stream_Net_GetStatus , FSOUND_Stream_Net_SetBufferProperties , FSOUND_Stream_Net_SetMetadataCallback , FSOUND_Stream_Net_SetProxy , FSOUND_Stream_Net_SetTimeout , FSOUND_Stream_Open , FSOUND_Stream_Play , FSOUND_Stream_PlayEx , FSOUND_Stream_Stop

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.