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    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50<title>nn::fs::FileInputStream</title>
51  </head>
52  <body>
53<h1><CODE>nn::fs::FileInputStream</CODE> Class</h1>
54<h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">class FileInputStream : <br />    private nn::fs::IInputStream,<br />    private nn::fs::detail::FileBase,<br />    private ADLFireWall::NonCopyable<FileInputStream></pre>
57    </div>
58<h2>Description</h2>
59    <div class="section">
60<p>Class for reading from files.</p><p>Can open the file specified by a path name and read data from it.</p><p>Although it is possible to use either wide-character strings or multibyte-character strings to specify the path name, use wide-character strings unless you have a special reason to do otherwise.</p><!-- write here --></div>
61    <a name="function" id="function">
62<h2>Member Functions</h2>
63      <div class="section">
64        <table class="members">
65          <tr>
66            <td width="100">  </td>
67            <th>
68<a href="../../../nn/fs/FileInputStream/FileInputStream.html"><CODE>FileInputStream</CODE></a>
69            </th>
70<td>Constructor.</td>
71          </tr>
72          <tr>
73            <td width="100">  </td>
74            <th>
75<a href="../../../nn/fs/FileInputStream/Initialize.html"><CODE>Initialize</CODE></a>
76            </th>
77<td>Opens the specified file.</td>
78          </tr>
79          <tr>
80            <td width="100">  </td>
81            <th>
82<a href="../../../nn/fs/FileInputStream/TryInitialize.html"><CODE>TryInitialize</CODE></a>
83            </th>
84<td>Tries to open the specified file.</td>
85          </tr>
86          <tr>
87            <td width="100">  </td>
88            <th>
89<a href="../../../nn/fs/FileInputStream/Finalize.html"><CODE>Finalize</CODE></a>
90            </th>
91<td>Closes a file.</td>
92          </tr>
93          <tr>
94<td width="100"> <span class="virtual_style" title="virtual">V</span>
95            </td>
96            <th>
97<a href="../../../nn/fs/FileInputStream/~FileInputStream.html"><CODE>~FileInputStream</CODE></a>
98            </th>
99<td>Destructor.</td>
100          </tr>
101          <tr>
102<td width="100"> <span class="virtual_style" title="virtual">V</span>
103            </td>
104            <th>
105<a href="../../../nn/fs/FileInputStream/Read.html"><CODE>Read</CODE></a>
106            </th>
107<td>Loads the specified amount of data from a file into a buffer.</td>
108          </tr>
109          <tr>
110<td width="100"> <span class="virtual_style" title="virtual">V</span>
111            </td>
112            <th>
113<a href="../../../nn/fs/FileInputStream/TryRead.html"><CODE>TryRead</CODE></a>
114            </th>
115<td>Loads the specified amount of data from a file into a buffer.</td>
116          </tr>
117          <tr>
118<td width="100"> <span class="virtual_style" title="virtual">V</span>
119            </td>
120            <th>
121<a href="../../../nn/fs/FileInputStream/Seek.html"><CODE>Seek</CODE></a>
122            </th>
123<td>Changes the read position of a file.</td>
124          </tr>
125          <tr>
126<td width="100"> <span class="virtual_style" title="virtual">V</span>
127            </td>
128            <th>
129<a href="../../../nn/fs/FileInputStream/TrySeek.html"><CODE>TrySeek</CODE></a>
130            </th>
131<td>Changes the read position of a file.</td>
132          </tr>
133          <tr>
134<td width="100"> <span class="virtual_style" title="virtual">V</span>
135            </td>
136            <th>
137<a href="../../../nn/fs/FileInputStream/GetPosition.html"><CODE>GetPosition</CODE></a>
138            </th>
139<td>Gets the current read position relative to the start of the file.</td>
140          </tr>
141          <tr>
142<td width="100"> <span class="virtual_style" title="virtual">V</span>
143            </td>
144            <th>
145<a href="../../../nn/fs/FileInputStream/TryGetPosition.html"><CODE>TryGetPosition</CODE></a>
146            </th>
147<td>Gets the current read position relative to the start of the file.</td>
148          </tr>
149          <tr>
150<td width="100"> <span class="virtual_style" title="virtual">V</span>
151            </td>
152            <th>
153<a href="../../../nn/fs/FileInputStream/SetPosition.html"><CODE>SetPosition</CODE></a>
154            </th>
155<td>Sets the current read position relative to the start of the file.</td>
156          </tr>
157          <tr>
158<td width="100"> <span class="virtual_style" title="virtual">V</span>
159            </td>
160            <th>
161<a href="../../../nn/fs/FileInputStream/TrySetPosition.html"><CODE>TrySetPosition</CODE></a>
162            </th>
163<td>Sets the current read position relative to the start of the file.</td>
164          </tr>
165          <tr>
166<td width="100"> <span class="virtual_style" title="virtual">V</span>
167            </td>
168            <th>
169<a href="../../../nn/fs/FileInputStream/GetSize.html"><CODE>GetSize</CODE></a>
170            </th>
171<td>Gets the file size.</td>
172          </tr>
173          <tr>
174<td width="100"> <span class="virtual_style" title="virtual">V</span>
175            </td>
176            <th>
177<a href="../../../nn/fs/FileInputStream/TryGetSize.html"><CODE>TryGetSize</CODE></a>
178            </th>
179<td>Gets the file size.</td>
180          </tr> </table>
181      </div>
182    </a>
183<h2>Class Hierarchy</h2>
184    <div class="section">
185<p class="hierarchy"><span>nn::fs::IPositionable</span><br />  <span>nn::fs::IInputStream</span><br />    <b>nn::fs::FileInputStream</b>
186      </p>
187    </div>
188<h2>Revision History</h2>
189    <div class="section">
190      <dl class="history">
191        <dt>2010/01/29</dt>
192<dd>Initial version.<br />
193        </dd>
194      </dl>
195    </div>
196  <hr><p>CONFIDENTIAL</p></body>
197</html>