nn::hio::CTR::SerialChannel::Read Member Function

Syntax

#include <nn/hio.h>
s32 Read(
     void * buf,
     size_t size,
     bit32 attr = ATTRIBUTE_NONE
);

Arguments

Name Description
out buf Buffer where the received data is stored.
in size Maximum size of the data to receive.
in attr Reception attribute.
If set to ATTRIBUTE_NONE, the function blocks until either size bytes can be received or the channel is closed.
If set to ATTRIBUTE_NO_WAIT, the function returns as soon as there is no more data to receive.

Return Values

Returns the actual number of bytes that were received. If an error occurred, returns -1.

Description

Receives data from the host and returns the size of data received.

size bytes of data are received to the buffer specified by buf.
The attr parameter specifies how to behave when the received data is fewer bytes than specified by size.
Returns the actual number of bytes that were received.

Revision History

2010/06/14
Added description of arguments and behavior.
2010/03/31
Initial version.

CONFIDENTIAL