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     <a href="../../../nn/boss/DstKind.html">DstKind</a> dstKind,
18     <a href="../../../nn_types/u16.html">u16</a> dataType,
19     <a href="../../../nn_types/u16.html">u16</a> period
20);
21</pre>
22    </div>
23    <h2>Parameters</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29            <th>Name</th>
30            <td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34          <td>in</td>
35          <th><CODE>gameId</CODE></th>
36          <td>Specifies the ID used to identify game servers. (For more details, see the documentation in the NEX library.)</td>
37        </tr>
38        <tr>
39          <td>in</td>
40          <th><CODE>pAccessKey</CODE></th>
41          <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>
42        </tr>
43        <tr>
44          <td>in</td>
45          <th><CODE>dstKind</CODE></th>
46          <td>Specifies the message data send destination type. (For more details, see the documentation in the NEX library.)</td>
47        </tr>
48        <tr>
49          <td>in</td>
50          <th>dataType</th>
51          <td>Specifies a value indicating the data type.</td>
52        </tr>
53        <tr>
54          <td>in</td>
55          <th><CODE>period</CODE></th>
56          <td>Specifies the number of days until data is automatically deleted. (For more details, see the documentation in the NEX library.)</td>
57        </tr> </table>
58    </div>
59    <h2>Return Values</h2>
60    <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 />
61      <table class="arguments">
62        <thead>
63          <tr>
64            <th>Value</th>
65            <td>Description</td>
66          </tr>
67        </thead>
68        <tr>
69          <th><CODE>Result::IsSuccess</CODE></th>
70          <td>Initialization successful.</td>
71        </tr>
72        <tr>
73          <th><CODE>ResultInvalidPointer</CODE></th>
74          <td>The pointer to the access key character string is NULL.</td>
75        </tr>
76        <tr>
77          <th><CODE>ResultInvalidSize</CODE></th>
78          <td>The access key string length is <CODE>0</CODE> or exceeds the maximum number of characters allowed.</td>
79        </tr>
80        <tr>
81          <th>A value other than the above</th>
82          <td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
83        </tr>
84      </table> </div>
85    <h2>Description</h2>
86    <div class="section">
87      <p>Used to configure <CODE>DataStore</CODE> upload.</p><p>When registering tasks, use the following functions. For normal execution: <CODE><a href="../../../nn/Result/Overview.html">nn::Result</a> RegisterTask(Task* pTask, TaskPolicy* pPolicy, TaskAction* pAction, const char* pFilePath, TaskOption* pOption=NULL, u8 taskStep=DEFAULT_STEP_ID)</CODE>. For immediate execution: <CODE><a href="../../../nn/Result/Overview.html">nn::Result</a> RegisterImmediateTask(Task* pTask, TaskAction* pAction, const char* pFilePath, TaskPolicy* pPolicy=NULL, TaskOption* pOption=NULL, u8 taskStep=DEFAULT_STEP_ID);</CODE>.</p><!-- write here --></div>
88    <h2>Revision History</h2>
89    <div class="section">
90      <dl class="history">
91        <dt>2011/10/27</dt>
92        <dd>Initial version.<br />
93        </dd>
94      </dl>
95    </div>
96  <hr><p>CONFIDENTIAL</p></body>
97</html>