-
Notifications
You must be signed in to change notification settings - Fork 1
/
dirent_8h.html
255 lines (233 loc) · 12.5 KB
/
dirent_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>PSP2SDK: include/psp2/io/dirent.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">PSP2SDK
 <span id="projectnumber">dirty-f9e4f2d</span>
</div>
<div id="projectbrief">The free SDK for PSP2</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">include/psp2/io/dirent.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Header file which describes the directory entry struct.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <<a class="el" href="types_8h_source.html">psp2/types.h</a>></code><br/>
<code>#include <<a class="el" href="stat_8h_source.html">psp2/io/stat.h</a>></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for dirent.h:</div>
<div class="dyncontent">
<div class="center"><img src="dirent_8h__incl.png" border="0" usemap="#include_2psp2_2io_2dirent_8h" alt=""/></div>
<map name="include_2psp2_2io_2dirent_8h" id="include_2psp2_2io_2dirent_8h">
<area shape="rect" id="node3" href="types_8h.html" title="Header file which defines unique variable types." alt="" coords="37,160,133,189"/><area shape="rect" id="node9" href="stat_8h.html" title="Header file which describes file structures." alt="" coords="79,83,180,112"/></map>
</div>
</div>
<p><a href="dirent_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSceIoDirent.html">SceIoDirent</a></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structSceIoDirent.html">SceIoDirent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="dirent_8h.html#a949070bd8103da23a98c626e9b0e8068">SceIoDirent</a></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a9c036549fd8cfd554ba3aa26a397b663">SceUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="dirent_8h.html#a99e6868991c01f146ecdd86b924eef1c">sceIoDopen</a> (const char *dirname)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dirent_8h.html#a9ed21c046e24cab62913f8d39e26809b">sceIoDread</a> (<a class="el" href="types_8h.html#a9c036549fd8cfd554ba3aa26a397b663">SceUID</a> fd, <a class="el" href="structSceIoDirent.html">SceIoDirent</a> *dir)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dirent_8h.html#acc2ca2130e3e8947f5fd18f5e2bd10e9">sceIoDclose</a> (<a class="el" href="types_8h.html#a9c036549fd8cfd554ba3aa26a397b663">SceUID</a> fd)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Header file which describes the directory entry struct. </p>
<p>Copyright (C) 2015 PSP2SDK Project</p>
<p>This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a949070bd8103da23a98c626e9b0e8068"></a><!-- doxytag: member="dirent.h::SceIoDirent" ref="a949070bd8103da23a98c626e9b0e8068" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structSceIoDirent.html">SceIoDirent</a> <a class="el" href="structSceIoDirent.html">SceIoDirent</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Describes a single directory entry </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="acc2ca2130e3e8947f5fd18f5e2bd10e9"></a><!-- doxytag: member="dirent.h::sceIoDclose" ref="acc2ca2130e3e8947f5fd18f5e2bd10e9" args="(SceUID fd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="dirent_8h.html#acc2ca2130e3e8947f5fd18f5e2bd10e9">sceIoDclose</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9c036549fd8cfd554ba3aa26a397b663">SceUID</a> </td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close an opened directory file descriptor</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>- Already opened file descriptor (using sceIoDopen) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>< 0 on error </dd></dl>
</div>
</div>
<a class="anchor" id="a99e6868991c01f146ecdd86b924eef1c"></a><!-- doxytag: member="dirent.h::sceIoDopen" ref="a99e6868991c01f146ecdd86b924eef1c" args="(const char *dirname)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a9c036549fd8cfd554ba3aa26a397b663">SceUID</a> <a class="el" href="dirent_8h.html#a99e6868991c01f146ecdd86b924eef1c">sceIoDopen</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>dirname</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open a directory</p>
<dl class="user"><dt><b>Example:</b></dt><dd><div class="fragment"><pre class="fragment"> <span class="keywordtype">int</span> dfd;
dfd = <a class="code" href="dirent_8h.html#a99e6868991c01f146ecdd86b924eef1c">sceIoDopen</a>(<span class="stringliteral">"device:/"</span>);
<span class="keywordflow">if</span>(dfd >= 0)
{ Do something with the file descriptor }
</pre></div> </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dirname</td><td>- The directory to open for reading. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>If >= 0 then a valid file descriptor, otherwise a Sony error code. </dd></dl>
</div>
</div>
<a class="anchor" id="a9ed21c046e24cab62913f8d39e26809b"></a><!-- doxytag: member="dirent.h::sceIoDread" ref="a9ed21c046e24cab62913f8d39e26809b" args="(SceUID fd, SceIoDirent *dir)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="dirent_8h.html#a9ed21c046e24cab62913f8d39e26809b">sceIoDread</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9c036549fd8cfd554ba3aa26a397b663">SceUID</a> </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSceIoDirent.html">SceIoDirent</a> * </td>
<td class="paramname"><em>dir</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads an entry from an opened file descriptor.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>- Already opened file descriptor (using sceIoDopen) </td></tr>
<tr><td class="paramname">dir</td><td>- Pointer to an io_dirent_t structure to hold the file information</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Read status<ul>
<li>0 - No more directory entries left</li>
<li>> 0 - More directory entired to go</li>
<li>< 0 - Error </li>
</ul>
</dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 15 2015 23:52:24 for PSP2SDK by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>