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>GetProperty</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>::GetProperty</CODE> Member Function</h1> 11<h2>Syntax</h2> 12 <div class="section"> 13 <pre class="definition"> 14virtual <a href="../../../nn/Result/Overview.html">nn::Result</a> GetProperty( 15 <a href="../../../nn/boss/PropertyType.html">PropertyType</a> type, 16 void * pValue, 17 size_t size 18); 19</pre> 20 </div> 21<h2>Parameters</h2> 22 <div class="section"> 23 <table class="arguments"> 24 <thead> 25 <tr> 26 <td width="15" /> 27<th>Name</th> 28<td>Description</td> 29 </tr> 30 </thead> 31 <tr> 32<td>in</td> 33<th><CODE>type</CODE></th> 34<td>Specifies the property identifier.</td> 35 </tr> 36 <tr> 37<td>out</td> 38<th><CODE>pValue</CODE></th> 39<td>Specifies the value.</td> 40 </tr> 41 <tr> 42<td>in</td> 43<th><CODE>size</CODE></th> 44<td>Specifies the value size.</td> 45 </tr> </table> 46 </div> 47<h2>Return Values</h2> 48<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 /> 49 <table class="arguments"> 50 <thead> 51 <tr> 52<th>Value</th> 53<td>Description</td> 54 </tr> 55 </thead> 56 <tr> 57<th><CODE>Result::IsSuccess</CODE></th> 58<td>Retrieval successful.</td> 59 </tr> 60 <tr> 61<th><CODE>ResultInvalidPropertyValue</CODE></th> 62<td>The property value pointer is <CODE>NULL</CODE>.</td> 63 </tr> 64 <tr> 65<th><CODE>ResultInvalidPropertyType</CODE></th> 66<td>The property type is not supported.</td> 67 </tr> 68 <tr> 69<th>A value other than the above.</th> 70<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td> 71 </tr> 72 </table> </div> 73<h2>Description</h2> 74 <div class="section"> 75<p>Gets a property value from the class.</p><p>It can be used for the following properties. Call this function after allocating memory for the description's data type.<br />Identifier Description<BR>Type code for <CODE>ACTION_CODE</CODE> tasks. The data type is <CODE>Action</CODE>. <CODE>ACTION_FILEDESC</CODE> The file identifier type. The data type is <CODE>FileDescriptor</CODE>. <CODE>ACTION_DATASTORE_GAME_ID</CODE> ID used to identify the game server. The data type is <CODE>u32</CODE>. <CODE>ACTION_DATASTORE_ACCESS_KEY</CODE> Key used to access the game server. The data type is <CODE>wchar_t[MAX_ACCESS_KEY_LENGTH]</CODE>. <CODE>ACTION_DATASTORE_DOWNLOAD_NEWS_SUBJECT</CODE> The subject title of notification data. The data type is <CODE>wchar_t[MAX_NEWS_SUBJECT_LENGTH</CODE>]. <CODE>ACTION_DATASTORE_DOWNLOAD_NEWS_MESSAGE</CODE> The body of notification data. The data type is <CODE>wchar_t[MAX_NEWS_MESSAGE_LENGTH</CODE>]. <CODE>ACTION_DATASTORE_DOWNLOAD_NEWS_JUMP_PARAM</CODE> General-purpose notification data jump parameter. The data type is <CODE>u8[MAX_NEWS_PARAM]</CODE>. <CODE>ACTION_DATASTORE_DOWNLOAD_NEWS_MODE</CODE> Toggle for issuing notification data. The data type is <CODE>NewsMode</CODE>. <CODE>ACTION_DATASTORE_DOWNLOAD_NEWS_SERIAL_ID</CODE> Notification data serial ID. The data type is <CODE>bit 32</CODE>.</p><!-- write here --></div> 76<h2>Revision History</h2> 77 <div class="section"> 78 <dl class="history"> 79 <dt>2011/10/27</dt> 80<dd>Initial version.<br /> 81 </dd> 82 </dl> 83 </div> 84 <hr><p>CONFIDENTIAL</p></body> 85</html> 86