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 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::hio::CTR::SharedMemoryChannel</title> 51 </head> 52 <body> 53<h1><CODE>nn::hio::CTR::SharedMemoryChannel</CODE> Class</h1> 54 <div class="section"> 55<b>Header file: </b>nn/hio.h</div> 56<h2>Syntax</h2> 57 <div class="section"> 58 <pre class="definition">class SharedMemoryChannel</pre> 59 </div> 60<h2>Description</h2> 61 <div class="section"> 62<p>Class that represents the channels used for shared memory.</p><p>The CTR target board can communicate with a PC by opening the same channel on both sides to use for shared memory.</p><p>With both devices have the same channel open, they can use shared memory.</p><!-- write here --></div> 63 <a name="function" id="function"> 64<h2>Member Functions</h2> 65 <div class="section"> 66 <table class="members"> 67 <tr> 68 <td width="100"> </td> 69 <th> 70<a href="../../../../nn/hio/CTR/SharedMemoryChannel/SharedMemoryChannel.html"><CODE>SharedMemoryChannel</CODE></a> 71 </th> 72<td>Constructor. You must make a separate call to <a href="../../../../nn/hio/CTR/SerialChannel/Open.html"><CODE>Open</CODE></a> to open a channel.</td> 73 </tr> 74 <tr> 75 <td width="100"> </td> 76 <th> 77<a href="../../../../nn/hio/CTR/SharedMemoryChannel/~SharedMemoryChannel.html"><CODE>~SharedMemoryChannel</CODE></a> 78 </th> 79<td>Destructor. Closes a channel if it is open.</td> 80 </tr> 81 <tr> 82 <td width="100"> </td> 83 <th> 84<a href="../../../../nn/hio/CTR/SharedMemoryChannel/Open.html"><CODE>Open</CODE></a> 85 </th> 86<td>Opens a channel.</td> 87 </tr> 88 <tr> 89 <td width="100"> </td> 90 <th> 91<a href="../../../../nn/hio/CTR/SharedMemoryChannel/Close.html"><CODE>Close</CODE></a> 92 </th> 93<td>Closes the channel.</td> 94 </tr> 95 <tr> 96 <td width="100"> </td> 97 <th> 98<a href="../../../../nn/hio/CTR/SharedMemoryChannel/GetSpaceSize.html"><CODE>GetSpaceSize</CODE></a> 99 </th> 100<td>Gets the size of the shared memory.</td> 101 </tr> 102 <tr> 103 <td width="100"> </td> 104 <th> 105<a href="../../../../nn/hio/CTR/SharedMemoryChannel/Read.html"><CODE>Read</CODE></a> 106 </th> 107<td>Reads data from shared memory and returns the result of the operation.</td> 108 </tr> 109 <tr> 110 <td width="100"> </td> 111 <th> 112<a href="../../../../nn/hio/CTR/SharedMemoryChannel/Write.html"><CODE>Write</CODE></a> 113 </th> 114<td>Writes data to shared memory and returns the result of the operation.</td> 115 </tr> </table> 116 </div> 117 </a> 118<h2>Revision History</h2> 119 <div class="section"> 120 <dl class="history"> 121 <dt>2010/03/31</dt> 122<dd>Initial version.<br /> 123 </dd> 124 </dl> 125 </div> 126 <hr><p>CONFIDENTIAL</p></body> 127</html>