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/boss/Overview.html">boss</a>::<a href="../../../nn/boss/DataStoreUploadAction/Overview.html">DataStoreUploadAction</a>::Initialize</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> Initialize(
15     <a href="../../../nn_types/u32.html">u32</a> gameId,
16     const wchar_t * pAccessKey,
17     nn::Handle fileHandle,
18     <a href="../../../nn/boss/DstKind.html">DstKind</a> dstKind,
19     <a href="../../../nn_types/u16.html">u16</a> dataType,
20     <a href="../../../nn_types/u16.html">u16</a> period
21);
22</pre>
23    </div>
24    <h2>Parameters</h2>
25    <div class="section">
26      <table class="arguments">
27        <thead>
28          <tr>
29            <td width="15" />
30            <th>Name</th>
31            <td>Description</td>
32          </tr>
33        </thead>
34        <tr>
35          <td>in</td>
36          <th><CODE>gameId</CODE></th>
37          <td>Specifies the ID used to identify game servers. (For more details, see the documentation in the NEX library.)</td>
38        </tr>
39        <tr>
40          <td>in</td>
41          <th><CODE>pAccessKey</CODE></th>
42          <td>Specifies the key used to access the game server. (Do not use more than 8 characters. See the NEX library documentation for details.)</td>
43        </tr>
44        <tr>
45          <td>in</td>
46          <th>fileHandle</th>
47          <td>Specifies the handle of the file to be uploaded.</td>
48        </tr>
49        <tr>
50          <td>in</td>
51          <th><CODE>dstKind</CODE></th>
52          <td>Specifies the message data send destination type. (For more details, see the documentation in the NEX library.)</td>
53        </tr>
54        <tr>
55          <td>in</td>
56          <th>dataType</th>
57          <td>Specifies a value indicating the data type.</td>
58        </tr>
59        <tr>
60          <td>in</td>
61          <th><CODE>period</CODE></th>
62          <td>Specifies the number of days until data is automatically deleted. (For more details, see the documentation in the NEX library.)</td>
63        </tr> </table>
64    </div>
65    <h2>Return Values</h2>
66    <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 /> <br />
67      <table class="arguments">
68        <thead>
69          <tr>
70            <th>Value</th>
71            <td>Description</td>
72          </tr>
73        </thead>
74        <tr>
75          <th><CODE>Result::IsSuccess</CODE></th>
76          <td>Initialization successful.</td>
77        </tr>
78        <tr>
79          <th><CODE>ResultInvalidPointer</CODE></th>
80          <td>The pointer to the access key character string is NULL.</td>
81        </tr>
82        <tr>
83          <th><CODE>ResultInvalidSize</CODE></th>
84          <td>The access key string length is <CODE>0</CODE> or exceeds the maximum number of characters allowed.</td>
85        </tr>
86        <tr>
87          <th>A value other than the above</th>
88          <td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
89        </tr>
90      </table> </div>
91    <h2>Description</h2>
92    <div class="section">
93      <p>Use to configure the settings attached to the <CODE>DataStore</CODE> upload file handle.</p><p>Special  version for configuring the file handle. Normally you should use <CODE>Initialize</CODE> in the following way. <CODE>Initialize(u32 gameId, const wchar_t* pAccessKey, DstKind dstKind, u16 dataType, u16 period)</CODE> <br /> Even if the <CODE><a href="../../../nn/boss/DataStoreUploadAction/Initialize.html">DataStoreUploadAction::Initialize</a></CODE> function has already been run on an object, this function can be re-run to allow the object to be reused.</p><!-- write here --></div>
94    <h2>Revision History</h2>
95    <div class="section">
96      <dl class="history">
97        <dt>2011/10/27</dt>
98        <dd>Initial version.<br />
99        </dd>
100      </dl>
101    </div>
102  <hr><p>CONFIDENTIAL</p></body>
103</html>