Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/sharedmem_8h.html
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Fri, 22 Jan 2010 18:26:19 +0000
changeset 1 25a17d01db0c
child 6 43e37759235e
permissions -rw-r--r--
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: examples/Base/IPC/condvar/condvarglobal/inc/sharedmem.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>examples/Base/IPC/condvar/condvarglobal/inc/sharedmem.h File Reference</h1>
<p>
<a href="sharedmem_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c144b91ecb225b1131135690ad990f3"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="1c144b91ecb225b1131135690ad990f3" args="(KChunkName,&quot;chunk&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KChunkName,&quot;chunk&quot;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d1f187f7aeef42475a82c57deac13af"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="4d1f187f7aeef42475a82c57deac13af" args="(KMutexName,&quot;mutex&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KMutexName,&quot;mutex&quot;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd6aa4dcff651260bbb32f0a7fa526ef"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="cd6aa4dcff651260bbb32f0a7fa526ef" args="(KCondVarName,&quot;condvar&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KCondVarName,&quot;condvar&quot;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0000f2ca37f1cce9f2dde8a32cd311c"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="b0000f2ca37f1cce9f2dde8a32cd311c" args="(KTxtEPOC32EX,&quot;EXAMPLES&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtEPOC32EX,&quot;EXAMPLES&quot;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="df763660b4a00ffda5eed0bfe1dc73e2"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="df763660b4a00ffda5eed0bfe1dc73e2" args="(KTxtExampleCode,&quot;Symbian platform Example Code&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtExampleCode,&quot;Symbian platform Example Code&quot;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="04a908410b4daaf83d48b270d8b58d13"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="04a908410b4daaf83d48b270d8b58d13" args="(KFormatFailed,&quot;failed: leave code=%d&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KFormatFailed,&quot;failed: leave code=%d&quot;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7495385e5a772ed24251d1d6c68500d4"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="7495385e5a772ed24251d1d6c68500d4" args="(KTxtOK,&quot;ok&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtOK,&quot;ok&quot;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12bee71c49b2abf7c526d1ad2bb7c3a6"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="12bee71c49b2abf7c526d1ad2bb7c3a6" args="(KTxtPressAnyKey,&quot; [press any key]&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtPressAnyKey,&quot; [press any key]&quot;)</td></tr>

<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sharedmem_8h.html#1006d8c149c84d799a92f7de74ebcf4c">KChunkSize</a> = 1</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sharedmem_8h.html#817ce7a9d8ca9ead92509953f8dcdcad">KLowerThreshold</a> = 10</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sharedmem_8h.html#0f2ae9d486d80c446844be5480b7bbc2">KUpperThreshold</a> = 20</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sharedmem_8h.html#bff4706ef1627715d044011a1f852d7c">KMaxValue</a> = 30</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sharedmem_8h.html#6e0ba2cbec05ae135edbcc64ba0f275f">KMinValue</a> = 0</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition in file <a class="el" href="sharedmem_8h-source.html">sharedmem.h</a>.</p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="1006d8c149c84d799a92f7de74ebcf4c"></a><!-- doxytag: member="sharedmem.h::KChunkSize" ref="1006d8c149c84d799a92f7de74ebcf4c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TInt <a class="el" href="sharedmem_8h.html#1006d8c149c84d799a92f7de74ebcf4c">KChunkSize</a> = 1          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The size of the shared memory chunk in bytes. 
<p>Definition at line <a class="el" href="sharedmem_8h-source.html#l00044">44</a> of file <a class="el" href="sharedmem_8h-source.html">sharedmem.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="817ce7a9d8ca9ead92509953f8dcdcad"></a><!-- doxytag: member="sharedmem.h::KLowerThreshold" ref="817ce7a9d8ca9ead92509953f8dcdcad" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TInt <a class="el" href="sharedmem_8h.html#817ce7a9d8ca9ead92509953f8dcdcad">KLowerThreshold</a> = 10          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The lower threshold for the shared memory variable. 
<p>Definition at line <a class="el" href="sharedmem_8h-source.html#l00049">49</a> of file <a class="el" href="sharedmem_8h-source.html">sharedmem.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="0f2ae9d486d80c446844be5480b7bbc2"></a><!-- doxytag: member="sharedmem.h::KUpperThreshold" ref="0f2ae9d486d80c446844be5480b7bbc2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TInt <a class="el" href="sharedmem_8h.html#0f2ae9d486d80c446844be5480b7bbc2">KUpperThreshold</a> = 20          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The upper threshold for the shared memory variable. 
<p>Definition at line <a class="el" href="sharedmem_8h-source.html#l00054">54</a> of file <a class="el" href="sharedmem_8h-source.html">sharedmem.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="bff4706ef1627715d044011a1f852d7c"></a><!-- doxytag: member="sharedmem.h::KMaxValue" ref="bff4706ef1627715d044011a1f852d7c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TInt <a class="el" href="sharedmem_8h.html#bff4706ef1627715d044011a1f852d7c">KMaxValue</a> = 30          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The maximum value for the shared memory variable. 
<p>Definition at line <a class="el" href="sharedmem_8h-source.html#l00059">59</a> of file <a class="el" href="sharedmem_8h-source.html">sharedmem.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="6e0ba2cbec05ae135edbcc64ba0f275f"></a><!-- doxytag: member="sharedmem.h::KMinValue" ref="6e0ba2cbec05ae135edbcc64ba0f275f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TInt <a class="el" href="sharedmem_8h.html#6e0ba2cbec05ae135edbcc64ba0f275f">KMinValue</a> = 0          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The minimum value for the shared memory variable. 
<p>Definition at line <a class="el" href="sharedmem_8h-source.html#l00064">64</a> of file <a class="el" href="sharedmem_8h-source.html">sharedmem.h</a>.</p>

</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:02 2010 for TB10.1 Example Applications by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>