nip2pDisableStream
int32_t nip2pDisableStream (nip2p_tStreamHandle streamHandle);
Purpose
Immediately disables a stream without flushing data from the writer. Any existing data in the writer is lost. To avoid data loss and guarantee all existing data in the writer is flushed to the reader before disabling the stream, use the nip2pFlushAndDisableStream function.
Parameters
Input |
Name |
Type |
Description |
streamHandle |
nip2p_tStreamHandle |
Specifies the stream to disable. |
Return Value
Name |
Type |
Description |
Error code |
int32_t |
Returns the error code for the session or execution thread.
Value |
Meaning |
0 |
No error. |
Positive Values |
Warning, but the operation succeeded. |
Negative Values |
An error occurred and the operation did not succeed. |
|