NS/main/source/includes/fmodapi375linux/documentation/HTML/FSOUND_Stream_Close.html
2014-12-16 14:36:27 +01:00

84 lines
3.2 KiB
HTML

<HTML>
<HEAD>
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>FSOUND_Stream_Close</TITLE>
<STYLE>
#flush {margin-left: -10p; margin-right: -0p}
#buttonbar {color: white}
</STYLE>
</HEAD>
<BODY TOPMARGIN=0 BGPROPERTIES="FIXED" BGCOLOR="white">
<FONT FACE="ARIAL">
<SPAN ID="flush">
<A NAME="SEE ALSO">
<TABLE WIDTH="100%" COLS=2 BORDER=0 BGCOLOR="#000000">
<TR ALIGN=RIGHT>
<TD ALIGN=LEFT>
<IMG SRC="banner03.gif" WIDTH="88" HEIGHT="31" BORDER=0>
</TD>
<TD ALIGN=RIGHT VALIGN=TOP>
<FONT FACE="ARIAL" SIZE="2">
<A ID=buttonbar HREF="FSOUND_Stream_AddSyncPoint.html">
<IMG SRC="u_prev.gif" WIDTH="71" HEIGHT="16" BORDER=0 ALT="Previous Topic">
</A>
<A ID=buttonbar HREF="FSOUND.html">
<IMG SRC="u_index.gif" WIDTH="47" HEIGHT="16" BORDER=0 ALT="Index">
</A>
<A ID=buttonbar HREF="FSOUND_Stream_Create.html">
<IMG SRC="u_next.gif" WIDTH="48" HEIGHT="16" BORDER=0 ALT="Next Topic">
</A>
</FONT></TD><TD WIDTH=15></TD>
</TR>
</TABLE>
</A>
</SPAN>
<A HREF="FSOUND.html#Functions"><H5>[API function]</A></H5>
<H2><A NAME="FSOUND_Stream_Close">FSOUND_Stream_Close</A></H2>
Shuts down and releases an FSOUND stream.<BR>
<P>
<B>signed char F_API </B><B> </B><B>FSOUND_Stream_Close</B><B>(</B><BR>
<B>FSOUND_STREAM *</B><I>stream</I><BR>
<B>);</B><BR>
<H3>Parameters</H3>
<TABLE>
<TR VALIGN=top><TD><I>stream</I></TD>
<TD>Pointer to the stream to be closed down.<BR>
</TD></TABLE>
<H3>Return Value</H3>
On success, TRUE is returned.<BR>
On failure, FALSE is returned.<BR>
<H3>Remarks</H3>
If the stream has been opened with FSOUND_NONBLOCKING, this function will not succeed until the stream is ready.<BR>
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.<BR>
___________________<BR>
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube<BR>
<H3>See Also</H3>
<A HREF="FSOUND_Stream_Create.html">FSOUND_Stream_Create</A>
,
<A HREF="FSOUND_Stream_Net_GetBufferProperties.html">FSOUND_Stream_Net_GetBufferProperties</A>
,
<A HREF="FSOUND_Stream_Net_GetLastServerStatus.html">FSOUND_Stream_Net_GetLastServerStatus</A>
,
<A HREF="FSOUND_Stream_Net_GetStatus.html">FSOUND_Stream_Net_GetStatus</A>
,
<A HREF="FSOUND_Stream_Net_SetBufferProperties.html">FSOUND_Stream_Net_SetBufferProperties</A>
,
<A HREF="FSOUND_Stream_Net_SetMetadataCallback.html">FSOUND_Stream_Net_SetMetadataCallback</A>
,
<A HREF="FSOUND_Stream_Net_SetProxy.html">FSOUND_Stream_Net_SetProxy</A>
,
<A HREF="FSOUND_Stream_Net_SetTimeout.html">FSOUND_Stream_Net_SetTimeout</A>
,
<A HREF="FSOUND_Stream_Open.html">FSOUND_Stream_Open</A>
,
<A HREF="FSOUND_Stream_Play.html">FSOUND_Stream_Play</A>
,
<A HREF="FSOUND_Stream_PlayEx.html">FSOUND_Stream_PlayEx</A>
,
<A HREF="FSOUND_Stream_Stop.html">FSOUND_Stream_Stop</A>
<HR><BR><FONT SIZE="-2">This document copyright &copy;Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.</FONT><BR>
<FONT SIZE="-2">Generated Thu Dec 15 17:31:35 2005
by SourceDoc v0.10, the automated source code documenter.</FONT><BR>
</BODY>
</HTML>