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>GetErrorCode</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/boss/Overview.html">boss</a>::GetErrorCode</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">nn::Result</a> GetErrorCode(
15     <a href="../../nn_types/u32.html">u32</a> * pOut,
16     <a href="../../nn/boss/TaskResultCode.html">TaskResultCode</a> targetResult
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>out</td>
32<th>pOut</th>
33<td>Buffer for storing error codes.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>targetResult</th>
38<td>Target result codes.</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 />
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>Retrieval successful.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultUnexpect</CODE></th>
56<td>An unexpected result code (result code for which an error code is not allocated) is passed.<br />(This <a href="../../nn/Result/Overview.html">Result</a> is also returned when the <B>pOut</B> parameter is <CODE>NULL</CODE>.)</td>
57        </tr>
58        <tr>
59<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
60<td>The session has not been initialized.<BR>This <CODE><a href="../../nn/Result/Overview.html">Result</a></CODE> is returned if this function is called before the <CODE><a href="../../nn/boss/Initialize.html">Initialize</A></CODE> function is called. Always call the <a href="../../nn/boss/Initialize.html"><CODE>Initialize</CODE></a> function before using the BOSS library.</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>The error code is acquired from the task result code (<a href="../../nn/boss/TaskResultCode.html"><CODE>TaskResultCode</CODE></a>).</p><p>The task result code is acquired with <a href="../../nn/boss/Task/GetResult.html"><CODE>nn::boss::Task::GetResult</CODE></a>.</p><p>If the task result is <span>UNKNOWN_ERROR</span>, a value not included in the enumerated type <a href="../../nn/boss/TaskResultCode.html">TaskResultCode</a> may be returned as the task result code. However, even this type of value can be converted to an error code. (In the case of <span>UNKNOWN_ERROR</span>, the task result code used is the sum of the value of the <span>UNKNOWN_ERROR</span> enumerator plus the ID of the module in which the error occurred (nnResult::Module).)</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>
80