FSOUND_Stream_SetPosition

##### [API function]

## FSOUND_Stream_SetPosition

Sets the current stream's FILE position in BYTES.

signed char F_API FSOUND_Stream_SetPosition(
FSOUND_STREAM *stream,
unsigned int position
);

### Parameters

stream | Pointer to the stream to have its position set.
position | Offset in bytes from start of actual sound data (not including any header)

### Return Value

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

### Remarks

Position functions for streams talk in bytes and NOT samples.
The reason for not taking the header into account is people usually want to know the offset to seek to relative to the start of their data (ie as they see it in soundforge or whatever), not from offset 0 which is almost meaningless if you dont know the format.
--------------
If the stream has been opened with FSOUND_NONBLOCKING, this function will not succeed until the stream is ready.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FSOUND_Stream_GetLength , FSOUND_Stream_GetPosition , FSOUND_Stream_SetTime

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.