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>GetRequiredMemorySize</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/socket/Overview.html">socket</a>::GetRequiredMemorySize</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14size_t GetRequiredMemorySize(
15     size_t bufferSizeForSockets,
16     s32 maxSessions
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>bufferSizeForSockets</th>
33<td>Number specified to the <a href="../../nn/socket/Initialize.html"><CODE>Initialize</CODE></a> argument of the same name.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>maxSessions</th>
38<td>Number specified to the <a href="../../nn/socket/Initialize.html"><CODE>Initialize</CODE></a> argument of the same name.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">The required work region size. </div>
43<h2>Description</h2>
44    <div class="section">
45<p>Gets the minimum amount of working memory required to initialize the socket library.</p><p>The working region is used to allocate the <a href="../../nn/socket/AddrInfo/Overview.html"><CODE>AddrInfo</CODE></a> values returned by the <a href="../../nn/socket/GetAddrInfo.html"><CODE>GetAddrInfo</CODE></a> function, but it is also used temporarily during function calls. Because this size value is calculated with some extra space reserved, you do not usually need to be concerned about what points in time the working region is being used. <br /><br />However, the required memory size does sometimes exceed the value returned by this function. This can happen, for example, if you get an <a href="../../nn/socket/AddrInfo/Overview.html"><CODE>AddrInfo</CODE></a> value with the <a href="../../nn/socket/GetAddrInfo.html"><CODE>GetAddrInfo</CODE></a> function, and then call <a href="../../nn/socket/GetAddrInfo.html"><CODE>GetAddrInfo</CODE></a> again without using the <a href="../../nn/socket/FreeAddrInfo.html"><CODE>FreeAddrInfo</CODE></a> function to free the <CODE>AddrInfo</CODE> value first.</p><!-- write here --></div>
46<h2>Revision History</h2>
47    <div class="section">
48      <dl class="history">
49        <dt>2010/08/16</dt>
50<dd>Initial version.<br />
51        </dd>
52      </dl>
53    </div>
54  <hr><p>CONFIDENTIAL</p></body>
55</html>
56