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/TaskStatus/Overview.html">TaskStatus</a>::GetProperty</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">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>type</th>
34<td>Specifies the property identifier.</td>
35        </tr>
36        <tr>
37<td>out</td>
38<th>pValue</th>
39<td>Specifies the value.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>size</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 />You must call the <a href="../../../nn/boss/Task/GetStateDetail.html"><CODE>nn::boss::Task::GetStateDetail</CODE></a> function at the point in time when you want to check the status.<br /><br /><B>Identifier: Description</B><br /><CODE>TASK_STATE_CODE</CODE>: Task state information. Its data type is <CODE>TaskStateCode</CODE>. <CODE>TASK_RESULT_CODE</CODE>: Task execution result code. Its data type is <CODE>TaskResultCode</CODE>. <CODE>TASK_SERVICE_STATUS</CODE>: Service availability status at the URL specified in the task attributes. Its data type is <CODE>TaskServiceStatus</CODE>. <CODE>TASK_SERVICE_TERMINATED</CODE>: Service availability flag at the URL specified in the task attributes. Its data type is <CODE>bool</CODE>. <CODE>TASK_COMM_ERROR_CODE</CODE>: Communications error code during task execution. The data type is <CODE>u32</CODE>. <br /><CODE>TASK_CURRENT_PRIORITY</CODE>: Current task execution priority. Data type is <CODE>u8</CODE>. <CODE>TASK_EXECUTE_COUNT</CODE>: Task execution count. The data type is <CODE>u32</CODE>. (<B>Note:</B> This execution count is not is not updated as often as the value returned by the <a href="../../../nn/boss/TaskPolicy/GetProperty.html"><CODE>TaskPolicy::GetProperty</CODE></a> function in response to <CODE>TASK_EXEC_COUNT</CODE>. Use <a href="../../../nn/boss/TaskPolicy/GetProperty.html"><CODE>TaskPolicy::GetProperty</CODE></a> when you want to get the most recent value.)<br /><CODE>TASK_PENDING_TIME</CODE>: Time elapsed since the scheduled task start time. The data type is <CODE>u32</CODE> (seconds). <CODE>TASK_START_TIME</CODE>: Scheduled task start time, based on a calendar beginning January 1, 2000. Its data type is <CODE>s64</CODE> (seconds). <CODE>TASK_PROGRESS</CODE>: Number of bytes downloaded. The data type is <CODE>u32</CODE>. <CODE>TASK_DATA_SIZE</CODE>: Total number of bytes to download from the target URL. The data type is <CODE>u32</CODE>. <CODE>TASK_CURRENT_STEP</CODE>: ID of the currently running task step. Data type is <CODE>u8</CODE>. <CODE>TASK_LAST_MODIFIED_TIME</CODE>: Last modified date and time, as returned in the HTTP response header. Data type is <CODE>char[MAX_LASTMODIFIED_LENGTH]</CODE>. <br /></p><!-- write here --></div>
76<h2>Revision History</h2>
77    <div class="section">
78      <dl class="history">
79        <dt>2010/09/16</dt>
80<dd>Initial version.<br />
81        </dd>
82      </dl>
83    </div>
84  <hr><p>CONFIDENTIAL</p></body>
85</html>
86