nn::ir::CTR::Communicator::Initialize Member Function

static Result Initialize(
     void * pBuf,
     size_t bufSize,
     size_t receiveBufferDataSize,
     size_t receiveBufferManagementSize,
     size_t sendBufferDataSize,
     size_t sendBufferManagementSize,
     nn::ir::CTR::BaudRate baudrate = nn::ir::CTR::BAUD_RATE_115200
);

	Name	Description
in	pBuf	Specifies the address of the buffer used for sending and receiving packets.
in	bufSize	Specifies the overall size of the buffer.
in	receiveBufferDataSize	Specifies the size of the region for saving received packets.
in	receiveBufferManagementSize	Specifies the size of the region for managing received packets.
in	sendBufferDataSize	Specifies the size of the region for saving outgoing packets.
in	sendBufferManagementSize	Specifies the size of the region for managing outgoing packets.
in	baudrate	Specifies the baud rate of communications.

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

Value	Description
Result::IsSuccess	Process was successful.
ResultAlreadyInitialized	Already initialized.
ResultFatalError	The IR module may be malfunctioning.

Initializes the IR library.

You must call this function before executing any of the other functions in the IR library.

The buffer size must be specified in units of 4 KB and have 4 KB alignment. The regions for saving and managing packets being sent and received are allocated in the specified sizes from the buffer. Thus, the overall buffer size must be at least as large as the sum of these regions.

2011/08/30

Initial version.