SpiStopStream - Parameters

hstream (HSTREAM) - input

The stream that is to perform the specified action.

ulFlags (ULONG) - input

Contains none or some of the following flags:

SPI_STOP_STREAM

Pause the stream. No data is lost. This is the default setting.
SPI_STOP_SLAVES
Stop master stream and any slave streams in the same sync group. If this flag is set, the hstream must be the stream handle of a master stream.
SPI_STOP_FLUSH
Continue to stream data until all stream buffers are empty. No new full buffers are accepted from the source stream handler. This is an asynchronous function.
SPI_STOP_DISCARD
Stop the stream and discard all stream buffers. This is an asynchronous function.

rc (ULONG) - returns

Return codes indicating success or the type of failure:

NO_ERROR

Success.
ERROR_INVALID_FUNCTION
Invalid function requested.
ERROR_INVALID_STREAM
Invalid stream handle.
ERROR_INVALID_FLAG
The flag passed is invalid.
ERROR_STREAM_NOTMASTER
Stop stream with SPI_STOP_SLAVES flag was specified, but the stream handle passed was not a synchronization master stream.
ERROR_STREAM_STOP_PENDING
A stream-stop is already pending.
ERROR_STREAM_ALREADY_STOP
The stream has been stopped or has reached the end of the data and stopped.
ERROR_STREAM_NOT_STARTED
The stream is either in the process of prerolling or the stream has been prerolled and a flush stop is requested.
ERROR_STREAM_ALREADY_PAUSE
The stream is already stopped (pause).
FAILURE
Stream handler-specific error return code.

---

[Back: SpiStopStream Return Value - rc]
[Next: SpiStopStream - Remarks]