stream_close_all :: Quanser C Functions

navigation bar

stream_close_all

Closes all streams established using stream_listen, stream_connect or stream_accept.

Description

This function closes all streams established using stream_listen, stream_connect or stream_accept. The list of streams is maintained in an internal database which is only valid within the context of the module which links with the quanser_communications static link library. Hence, the stream API cannot be called from an RTDLL unless the RTDLL is only used by a single RTSSS process. Also, if two separate modules in the same process link with the quanser_communications library then the stream functions will only recognize a stream as valid if it was established by the same module.

Prototype

t_error
stream_close_all(void);

Parameters

This function has no parameters.

Return value

Returns 0 on success. If an error occurs then a negative error code is returned.

Error codes

This function does not return any error code.

Requirements

Include Files	Libraries
quanser_stream.h	quanser_communications.lib;quanser_runtime.lib;quanser_common.lib

Examples

try {
    ...
} catch (...) {
    ...
    stream_close_all;       
}