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>GetStorageInfo</title>
8  </head>
9  <body>
10<h1><CODE>nn::boss::GetStorageInfo</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">nn::Result</a> GetStorageInfo(
15size_t * pStorageSize = NULL
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><CODE>pStorageSize</CODE></th>
32<td>Returns the size of the BOSS storage region. (Optional)</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<div class="section">Returns the function's execution result. Returns one of the <a href="../../nn/Result/Overview.html"><CODE>Result</CODE></A></a> values listed below. <br />
37      <table class="arguments">
38        <thead>
39          <tr>
40<th>Value</th>
41<td>Description</td>
42          </tr>
43        </thead>
44        <tr>
45<th><CODE>ResultSuccess</CODE></th>
46<td>Retrieval successful.</td>
47        </tr>
48        <tr>
49<th><CODE>ResultStorageNotFound</CODE></th>
50<td>Storage has not been registered for the corresponding application ID. Confirm whether storage registration is complete.</td>
51        </tr>
52        <tr>
53<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
54<td>Either a session had not been initialized or there were incompatible permissions. This <CODE>Result</CODE> is returned if this function is called before either the <A><CODE>Initialize</CODE></A> or the <CODE>InitializePriviledged</CODE> function is called. When using the BOSS library, always begin by calling either the <A><CODE>Initialize</CODE></A> or the <CODE>InitializePriviledged</CODE> function.</td>
55        </tr>
56        <tr>
57<th>A value other than the above.</th>
58<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
59        </tr>
60      </table> </div>
61<h2>Description</h2>
62    <div class="section">
63<p>Gets the size of the registered BOSS storage region. Can confirm whether storage registration is complete.</p><!-- write here --></div>
64<h2>Revision History</h2>
65    <div class="section">
66      <dl class="history">
67        <dt>2010/11/10</dt>
68<dd>Initial version.<br />
69        </dd>
70      </dl>
71    </div>
72  <hr><p>CONFIDENTIAL</p></body>
73</html>