nn::ir::CTR::Communicator::GetNextReceiveDataSize Member Function

Syntax

static Result GetNextReceiveDataSize(
     size_t * pSize
);

Parameters

Name Description
out pSize Stores the size of the receive data.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.

Value Description
Result::IsSuccess Process was successful.
ResultNotConnected System is not connected.
ResultNoData No received data.
ResultMachineSleep Sleeping because the system is in Sleep Mode.
ResultFatalError The IR module may be malfunctioning.

Description

Returns the size of data that will be received in the next call to the Receive function.

This size includes the header and other data added for communication between systems. In other words, it returns the size of the portion of the received packet that is calculated by the CalculateBufferSizeToCommunicate function.

Use this function when you need to know ahead of time the buffer size required to execute the Receive function.

Revision History

2011/08/30
Initial version.

CONFIDENTIAL