NNS_McsReadStream

Syntax

#include <nnsys/mcs.h>
BOOL NNS_McsReadStream(
         u16         channel,
         void*       data,
         u32         size,
         u32*        pReadSize);

Arguments

channel Value for identifying a stream. You can specify in the range 0 to 0x3FFF. 0x4000 to 0x7FFF is reserved for TWL-System applications. 0x8000 to 0xFFFF is reserved for the MCS system.
data Pointer to the buffer where read data is to be stored.
size Size of the buffer where read data is to be stored.
pReadSize Size of data that was actually read.

Return Values

TRUE if the function operates successfully. FALSE if it fails.

Description

Acts to receive data.

If the length of received data exceeds the size of the buffer as specified by size, only this size portion of the data is read into the buffer. If this occurs, the function returns FALSE. Use the NNS_McsGetStreamReadableSize function to get the remaining size.

See Also

NNS_McsWriteStream

Revision History

2008/06/20 Changed NITRO-System to TWL-System.
2004/10/08 Added a description of the channel argument.
2004/08/26 Corrected Description and changed the type of the argument channel.
2004/06/01 Initial version.

CONFIDENTIAL