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>Disconnect</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>::Disconnect</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> Disconnect( 15 void 16); 17</pre> 18 </div> 19 <h2>Parameters</h2> 20 <div class="section"> 21 <p>None.</p> 22 </div> 23 <h2>Return Values</h2> 24 <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 /> 25 <table class="arguments"> 26 <thead> 27 <tr> 28 <th>Value</th> 29 <td>Description</td> 30 </tr> 31 </thead> 32 <tr> 33 <th><CODE>Result::IsSuccess</CODE></th> 34 <td>Process was successful.</td> 35 </tr> 36 <tr> 37 <th><CODE>ResultNotConnected</CODE></th> 38 <td>Neither connected nor in the process of connecting.</td> 39 </tr> 40 <tr> 41 <th><CODE>ResultMachineSleep</CODE></th> 42 <td>Sleeping because the system is in Sleep Mode.</td> 43 </tr> 44 <tr> 45 <th><CODE>ResultFatalError</CODE></th> 46 <td>The IR module may be malfunctioning.</td> 47 </tr> 48 </table> </div> 49 <h2>Description</h2> 50 <div class="section"> 51 <p>Disconnects the current connection or aborts the connection authentication process.</p><p>This function returns control before the disconnection process is completed.</p><p>If the system is in the connected state, a disconnection request is sent to the peer. If the system is performing the connection authentication process, that process is cancelled.</p><p>If there are unprocessed outgoing packets, these will be destroyed and the disconnection process will proceed. If this is going to be a problem, do not call this function until you have confirmed that the sending of packets has completed.</p><p>All packets that have been received before disconnection can be processed by the <CODE>Receive</CODE> function even after the disconnection is completed. However, note that these packets will be deleted at the start of the next connection or connection authentication process.</p><!-- write here --></div> 52 <h2>Revision History</h2> 53 <div class="section"> 54 <dl class="history"> 55 <dt>2011/08/30</dt> 56 <dd>Initial version.<br /> 57 </dd> 58 </dl> 59 </div> 60 <hr><p>CONFIDENTIAL</p></body> 61</html> 62