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>GetBufferFullEvent</title>
8  </head>
9  <body>
10<h1><CODE>nn::mic::CTR::GetBufferFullEvent</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">Result</a> GetBufferFullEvent(
15     <a href="../../../nn/os/Event/Overview.html">nn::os::Event</a> * pEvent
16);
17</pre>
18    </div>
19<h2>Arguments</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>out</td>
31<th>pEvent</th>
32<td>Manually resetting event that is caused when the buffer is full.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<div class="section">Returns the result of the operation.<br />Success: <CODE>LEVEL_SUCCESS:SUMMARY_SUCCESS:MODULE_COMMON:DESCRIPTION_SUCCESS</CODE>. </div>
37<h2>Description</h2>
38    <div class="section">
39<p>Gets the manually resetting event used to detect when the microphone buffer is full.</p><p>The <a href="../../../nn/os/Event/Overview.html"><CODE>nn::os::Event</CODE></a> object is signaled when the amount of data specified by the <SPAN class="argument">size</SPAN> argument of the <CODE><a href="../../../nn/mic/CTR/StartSampling.html">StartSampling</a></CODE> member function has been written.<br /><a href="../../../nn/mic/CTR/StartSampling.html">If <SPAN>loop</SPAN> is set to <CODE>true</CODE> in <CODE><a href="../../../nn/mic/CTR/StartSampling.html">StartSampling</a></CODE> and sampling will be performed from the <CODE>offset</CODE> position, the <CODE><a href="../../../nn/os/Event/Overview.html">nn::os::Event</a></CODE> object will be signaled after <CODE>size</CODE> bytes of data have been written.<br /></p><p>Because this is a manually resetting event, once the event has been signaled you must call <a href="../../../nn/os/Event/ClearSignal.html"><CODE>nn::os::Event::ClearSignal</CODE></a> if you want to retrieve another event.</p><!-- write here --></div>
40<h2>Revision History</h2>
41    <div class="section">
42      <dl class="history">
43        <dt>2010/01/07</dt>
44<dd>Initial version.<br />
45        </dd>
46      </dl>
47    </div>
48  <hr><p>CONFIDENTIAL</p></body>
49</html>