##### [API function]

## FSOUND_Stream_GetOpenState

If a stream is opened with FSOUND_NONBLOCKING, this function returns the state of the opening stream.

int F_API FSOUND_Stream_GetOpenState(
FSOUND_STREAM *stream
);

### Parameters

stream | Pointer to the stream to get the open state from.

### Return Value

0 = stream is opened and ready.
-1 = stream handle passed in is invalid.
-2 = stream is still opening or performing a SetSubStream command.
-3 = stream failed to open. (file not found, out of memory or other error).
-4 = connecting to remote host (internet streams only)
-5 = stream is buffering data (internet streams only)

### Remarks

A blocking stream will return NULL from FSOUND_Stream_Open so a return value of -3 is redundant in this case.
A blocking stream will always return 0 if it is not NULL.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FSOUND_Stream_Open , FSOUND_Stream_SetSubStream , FSOUND_Stream_SetSubStreamSentence

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