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>GetHeaderInfo</title>
8  </head>
9  <body>
10<h1><CODE>nn::boss::NsData::GetHeaderInfo</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> GetHeaderInfo(
15<a href="../../../nn/boss/HeaderInfoType.html">HeaderInfoType</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>in</td>
33<th>type</th>
34<td>Specifies the header element type.</td>
35        </tr>
36        <tr>
37<td>out</td>
38<th>pValue</th>
39<td>Specifies a buffer storing the header information.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>size</th>
44<td>Buffer 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 />
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>ResultSuccess</CODE></th>
58<td>Read successfully.</td>
59        </tr>
60        <tr>
61<th>ResultInvalidNsDataValue</th>
62<td>The pointer to the region that stores NSDATA is <CODE>NULL</CODE>.</td>
63        </tr>
64        <tr>
65<th><CODE>ResultNsDataNotFound</CODE></th>
66<td>The specified NS data is not found. Might have been deleted with an auto-delete.</td>
67        </tr>
68        <tr>
69<th><CODE>ResultInvalidNsDataGetHeadSize</CODE></th>
70<td>The header size does not match the header type specified by the <CODE>GetHeaderInfo</CODE> function. Normally this doesn't occur, but it is possible that something abnormal occurred.</td>
71        </tr>
72        <tr>
73<th><CODE>ResultStorageAccessPermission</CODE></th>
74<td>You do not have permission to access storage. Cannot access the expanded save region. Re-confirm whether you have access rights.</td>
75        </tr>
76        <tr>
77<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
78<td>Either a session had not been initialized or there were incompatible permissions. This <CODE>Result</CODE> is returned if this function is called before either the <A><CODE>Initialize</CODE></A> or the <CODE>InitializePriviledged</CODE> function is called. When using the BOSS library, always begin by calling either the <A><CODE>Initialize</CODE></A> or the <CODE>InitializePriviledged</CODE> function.</td>
79        </tr>
80        <tr>
81<th>A value other than the above.</th>
82<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
83        </tr>
84      </table> </div>
85<h2>Description</h2>
86    <div class="section">
87<p>Reads NS archive header information. When the following types of NSA header information are specified, you can get the corresponding values. At that time, you will need to have allocated the necessary memory. When less than the necessary memory is available, the <A><CODE>ResultInvalidNsDataGetHeadSize</CODE></A> error is returned. <CODE>NSD_TITLEID</CODE>: a 64-bit title ID. (s64) <CODE>NSD_FLAGS</CODE>: The NSD flag. (bit32) <CODE>NSD_DATATYPE</CODE>: The NSD data type. (bit32) <CODE>NSD_LENGTH</CODE>: The NSD length. (s32) <CODE>NSD_SERIALID</CODE>: The NSD serial ID. (u32) <CODE>NSD_VERSION</CODE>: The NSD version number. (u32) Note that the specified NS data file might not be found, such as if the file was auto-deleted or if there was not enough space available when downloading the NS archive.</p><!-- write here --></div>
88<h2>Revision History</h2>
89    <div class="section">
90      <dl class="history">
91        <dt>2010/09/16</dt>
92<dd>Initial version.<br />
93        </dd>
94      </dl>
95    </div>
96  <hr><p>CONFIDENTIAL</p></body>
97</html>