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/DataStoreDownloadAction/Overview.html">DataStoreDownloadAction</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); 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><CODE>gameId</CODE></th> 33<td>Specifies the ID used to identify game servers. (For more details, see the documentation in the NEX library.)</td> 34 </tr> 35 <tr> 36<td>in</td> 37<th><CODE>pAccessKey</CODE></th> 38<td>Specifies the key used to access the game server. (Do not denote more than 8 characters. See the NEX library documentation for details.)</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 /> <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>Initialization successful.</td> 53 </tr> 54 <tr> 55<th><CODE>ResultInvalidPointer</CODE></th> 56<td>The pointer to the access key character string is NULL.</td> 57 </tr> 58 <tr> 59<th><CODE>ResultInvalidSize</CODE></th> 60<td>The access key string length is <CODE>0</CODE> or exceeds the maximum number of characters allowed.</td> 61 </tr> 62 <tr> 63<th>A value other than the above.</th> 64<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td> 65 </tr> 66 </table> </div> 67<h2>Description</h2> 68 <div class="section"> 69<p>Configures <CODE>DataStore</CODE> download tasks.</p><p>Even if the <a href="../../../nn/boss/DataStoreDownloadAction/Initialize.html"><CODE>DataStoreDownloadAction::Initialize</CODE></a> 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> 70<h2>Revision History</h2> 71 <div class="section"> 72 <dl class="history"> 73 <dt>2011/10/27</dt> 74<dd>Initial version.<br /> 75 </dd> 76 </dl> 77 </div> 78 <hr><p>CONFIDENTIAL</p></body> 79</html>