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>SetBuffer</title>
8  </head>
9  <body>
10<h1><CODE>nn::mic::CTR::SetBuffer</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">Result</a> SetBuffer(
15     void * address,
16     size_t size
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th><CODE>address</CODE></th>
33<td>Specifies the starting address of the memory block.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th><CODE>size</CODE></th>
38<td>Specifies the size of the memory region.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the result of the operation.<br /><CODE>LEVEL_SUCCESS:SUMMARY_SUCCESS:MODULE_COMMON:DESCRIPTION_SUCCESS</CODE>: Success.<br /><CODE>LEVEL_PERMANENT:SUMMARY_NOTHING_HAPPENED:MODULE_NN_MIC:DESCRIPTION_ALREADY_INITIALIZED</CODE>: The memory region has already been set.<br /><CODE>LEVEL_USAGE:SUMMARY_NOTHING_HAPPENED:MODULE_NN_MIC:DESCRIPTION_MISALIGNED_SIZE</CODE>: The size of the specified memory region is not aligned to 4096 bytes.<br />LEVEL_USAGE:SUMMARY_NOTHING_HAPPENED:MODULE_NN_MIC:DESCRIPTION_MISALIGNED_ADDRESS: The address of the specified memory region is not aligned to 4096 bytes. </div>
43<h2>Description</h2>
44    <div class="section">
45<p>Sets the memory region in which to store the sampling results.</p><p>Set the memory that was obtained by the application. Device memory cannot be used.</p><p>The <CODE>SetBuffer</CODE> function cannot be called multiple times. If you have already called <CODE>SetBuffer</CODE> but want to call it again, you must call <a href="../../../nn/mic/CTR/ResetBuffer.html"><CODE>nn::mic::CTR::ResetBuffer</CODE></a> first.</p><p>The size of the memory region you specify must be aligned to 4096 bytes. The address of the memory region you specify must be aligned to 4096 bytes. The last four bytes of the specified memory region are used by the mic library for administrative purposes. Do not overwrite the last four bytes of this region. The size of the buffer in which the actual sampling results are saved is the size obtained using <a href="../../../nn/mic/CTR/GetSamplingBufferSize.html"><CODE>nn::mic::CTR::GetSamplingBufferSize</CODE></a>.</p><!-- write here --></div>
46<h2>Revision History</h2>
47    <div class="section">
48      <dl class="history">
49        <dt>2010/06/23</dt>
50<dd>Initial version.<br />
51        </dd>
52      </dl>
53    </div>
54  <hr><p>CONFIDENTIAL</p></body>
55</html>