1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" /> 7 <title>Initialize</title> 8 </head> 9 <body> 10 <h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/ir/Overview.html">ir</a>::<a href="../../../../nn/ir/CTR/Overview.html">CTR</a>::<a href="../../../../nn/ir/CTR/Communicator/Overview.html">Communicator</a>::Initialize</CODE> Member Function</h1> 11 <h2>Syntax</h2> 12 <div class="section"> 13 <pre class="definition"> 14static <a href="../../../../nn/Result/Overview.html">Result</a> Initialize( 15 void * pBuf, 16 size_t bufSize, 17 size_t receiveBufferDataSize, 18 size_t receiveBufferManagementSize, 19 size_t sendBufferDataSize, 20 size_t sendBufferManagementSize, 21 <a href="../../../../nn/ir/CTR/BaudRate.html">nn::ir::CTR::BaudRate</a> baudrate = nn::ir::CTR::BAUD_RATE_115200 22); 23</pre> 24 </div> 25 <h2>Parameters</h2> 26 <div class="section"> 27 <table class="arguments"> 28 <thead> 29 <tr> 30 <td width="15" /> 31 <th>Name</th> 32 <td>Description</td> 33 </tr> 34 </thead> 35 <tr> 36 <td>in</td> 37 <th>pBuf</th> 38 <td>Specifies the address of the buffer used for sending and receiving packets.</td> 39 </tr> 40 <tr> 41 <td>in</td> 42 <th>bufSize</th> 43 <td>Specifies the overall size of the buffer.</td> 44 </tr> 45 <tr> 46 <td>in</td> 47 <th>receiveBufferDataSize</th> 48 <td>Specifies the size of the region for saving received packets.</td> 49 </tr> 50 <tr> 51 <td>in</td> 52 <th>receiveBufferManagementSize</th> 53 <td>Specifies the size of the region for managing received packets.</td> 54 </tr> 55 <tr> 56 <td>in</td> 57 <th>sendBufferDataSize</th> 58 <td>Specifies the size of the region for saving outgoing packets.</td> 59 </tr> 60 <tr> 61 <td>in</td> 62 <th>sendBufferManagementSize</th> 63 <td>Specifies the size of the region for managing outgoing packets.</td> 64 </tr> 65 <tr> 66 <td>in</td> 67 <th>baudrate</th> 68 <td>Specifies the baud rate of communications.</td> 69 </tr> </table> 70 </div> 71 <h2>Return Values</h2> 72 <div class="section">Returns the function's execution result. Returns one of the <a href="../../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below.<br /> <br /> 73 <table class="arguments"> 74 <thead> 75 <tr> 76 <th>Value</th> 77 <td>Description</td> 78 </tr> 79 </thead> 80 <tr> 81 <th><CODE>Result::IsSuccess</CODE></th> 82 <td>Process was successful.</td> 83 </tr> 84 <tr> 85 <th><CODE>ResultAlreadyInitialized</CODE></th> 86 <td>Already initialized.</td> 87 </tr> 88 <tr> 89 <th><CODE>ResultFatalError</CODE></th> 90 <td>The IR module may be malfunctioning.</td> 91 </tr> 92 </table> </div> 93 <h2>Description</h2> 94 <div class="section"> 95 <p>Initializes the IR library.</p><p>You must call this function before executing any of the other functions in the IR library.</p><p>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.</p><!-- write here --></div> 96 <h2>Revision History</h2> 97 <div class="section"> 98 <dl class="history"> 99 <dt>2011/08/30</dt> 100 <dd>Initial version.<br /> 101 </dd> 102 </dl> 103 </div> 104 <hr><p>CONFIDENTIAL</p></body> 105</html> 106