stream_receive_byte_array stream_receive_ubytes navigation bar

Table of Contents

stream_receive_ubyte

Receives a single unsigned byte over a client stream.

Description

This function receives a single unsigned 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_ubyte(t_stream stream, t_ubyte * value);

    

Parameters

t_stream stream

A client stream established using stream_connect or stream_accept.

t_ubyte * value

A pointer to a t_ubyte 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

 

navigation bar