NNS_McsReadStream

C Specification

#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-0x3FFF. 0x4000-0x7FFF is reserved for NITRO-System applications. 0x8000-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 Actual size of read data.

Return Values

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

Description

This function acts to receive data.

If the length of received data exceeds the size of the buffer size as specified by size, then only this size portion of the data is read into the buffer. If this occurs, the function returns FALSE. The remaining balance of data can be gotten with NNS_McsGetStreamReadableSize().

See Also

NNS_McsWriteStream

Revision History

2004/10/08 Added a description of the channel argument.
2004/08/26 Corrected the Description and changed the argument channel type.
2004/06/01 Initial version.


CONFIDENTIAL