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>nn::boss::TaskAction::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,
16void * pValue,
17size_t size
18);
19</pre>
20    </div>
21<h2>Arguments</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 />
33<th>type</th>
34          <td>
35            </td>
36        </tr>
37        <tr>
38          <td />
39<th>pValue</th>
40          <td>
41            </td>
42        </tr>
43        <tr>
44          <td />
45<th>size</th>
46          <td>
47            </td>
48        </tr>
49        <tr>
50<td>in</td>
51<th><CODE>PropertyType</CODE></th>
52<td>Specifies the <CODE>type</CODE> property identifier.</td>
53        </tr>
54        <tr>
55<td>in</td>
56<th>void *</th>
57<td>Specifies a <CODE>pValue</CODE> value.</td>
58        </tr>
59        <tr>
60<td>in</td>
61<th>size_t</th>
62<td>Specifies the size of the <CODE>size</CODE> value.</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 />
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>ResultSuccess</CODE></th>
76<td>Retrieval successful.</td>
77        </tr>
78        <tr>
79<th><CODE>ResultInvalidPropertyValue</CODE></th>
80<td>The property value pointer is <CODE>NULL</CODE>.</td>
81        </tr>
82        <tr>
83<th><CODE>ResultInvalidPropertyType</CODE></th>
84<td>The property type is not supported.</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>Gets a property value from the class. It can be used for the following properties.<br />Identifier type <br /> <CODE>ACTION_URL char url[MAX_URL_LENGTH]</CODE> <br /> <CODE>ACTION_OFFSET u32</CODE> <br /> <CODE>ACTION_FILEPATH char filepath [MAX_FILEPATH_LENGTH]</CODE> <br /> <CODE>ACTION_FILEPATH_W wchar_t filePathW[MAX_FILEPATH_LENGTH]</CODE> <br /> <CODE>ACTION_FILE_HANDLE <a href="../../../nn/Handle/Overview.html">nn::Handle</a></CODE> <br /> <CODE>ACTION_HTTP_HEADER struct httpRequestHeader[MAX_HTTP_HEADER]</CODE> <br /> <CODE>ACTION_CLIENT_CERT u8</CODE> <br /> <CODE>ACTION_ROOT_CA u8</CODE> <br /> <CODE>ACTION_AP_INFO ApInfoType</CODE> <br /> <CODE>SIGNAL_TASK_EVENT <a href="../../../nn/os/Event/Overview.html">nn::os::Event</a>*</CODE> <br /></p><!-- write here --></div>
94<h2>Revision History</h2>
95    <div class="section">
96      <dl class="history">
97        <dt>2010/09/16</dt>
98<dd>Initial version.<br />
99        </dd>
100      </dl>
101    </div>
102  <hr><p>CONFIDENTIAL</p></body>
103</html>