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>Initialize</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/http/Overview.html">http</a>::Initialize</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">Result</a> Initialize(
15     <a href="../../nn_types/uptr.html">uptr</a> bufferAddress = 0,
16     size_t bufferSize = 0
17);
18</pre>
19    </div>
20<h2>Parameters</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>bufferAddress</th>
33<td>Pointer to the start of the POST data buffer. The memory for the buffer must be 4096-byte aligned.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>bufferSize</th>
38<td>Size of the POST data buffer.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the function's execution result. Returns one of the <a href="../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
43      <table class="arguments">
44        <thead>
45          <tr>
46<th>Value</th>
47<td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51<th><CODE>Result::IsSuccess</CODE></th>
52<td>Process was successful. HTTP library can be used.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultClientProcessMaxErr</CODE></th>
56<td>Error indicating that the maximum number of simultaneous client processes are already in use. Trying again later may succeed (provided another module calls <a href="../../nn/http/Finalize.html"><CODE>Finalize</CODE></a> in the meantime).</td>
57        </tr>
58        <tr>
59<th><CODE>ResultIpcSessionMaxErr</CODE></th>
60<td>Error indicating that the maximum number of simultaneous IPC sessions are already connected. Trying again later may succeed (provided another IPC session succeeds in the meantime).</td>
61        </tr>
62        <tr>
63<th><CODE>ResultAlreadyInitializedErr</CODE></th>
64<td>Error indicating initialization is already complete. HTTP library can already be used.</td>
65        </tr>
66        <tr>
67<th>A value other than the above.</th>
68<td>Unexpected error. (See <CODE>http_Result.h</CODE> for details.)</td>
69        </tr>
70      </table> </div>
71<h2>Description</h2>
72    <div class="section">
73<p>Initializes the HTTP library. Processes that link against the HTTP library must call this before using the library.</p><p>You must use this function's arguments to set the POST data buffer before you can use the <CODE>AddPostData</CODE>-related functions of <CODE>nn::http::Connection</CODE> (the functions that register POST data before <CODE>Connect</CODE> runs). <br />If you are not using the <CODE>AddPostData</CODE>-related functions you do not need to set anything in the argument. (In other words, even if you are using POST operations, nothing needs to be set in the argument if you use only <CODE>SendPostData</CODE>-related functions.)<br /><br /> The POST data buffer is used to temporarily store the registered POST data.<br /> For this reason, the buffer size must be at least as large as the maximum total amount of POST data that will be registered at any one time. <br />(The POST data registered in <CODE>nn::http::Connection</CODE> is stored temporarily in the POST data buffer, sent via POST when <CODE>nn::http::Connection::Connect</CODE> executes, and freed when <CODE>nn::http::Connection::Finalize</CODE> executes. Accordingly, the size of the POST data buffer must be at least as large as the maximum total amount of POST data registered to the <CODE>nn::http::Connection</CODE> object at any one time before <CODE>Finalize</CODE>.)</p><!-- write here --></div>
74<h2>Revision History</h2>
75    <div class="section">
76      <dl class="history">
77        <dt>2010/06/14</dt>
78<dd>Initial version.<br />
79        </dd>
80      </dl>
81    </div>
82  <hr><p>CONFIDENTIAL</p></body>
83</html>
84