stream_receive_byte
Receives a single byte over a client stream.
Description
This function receives a single byte over a client stream. It has the same semantics as the stream_receive function except that it only receives a single byte.
Prototype
t_int stream_receive_byte(t_stream stream, t_byte * value);
Parameters
t_stream stream
A client stream established using stream_connect or stream_accept.
t_byte * value
A pointer to a t_byte variable in which the received data will be stored.
Return value
The number of bytes received, which will always be 1. If no more data is available and the connection has been closed gracefully then 0 is returned. 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 |
See Also
Copyright ©2024 Quanser Inc. This page was generated 2024-10-17. Submit feedback to Quanser about this page.