doc/oscl_html/classOscl__FileServer.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

<!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"/>
<title>oscl: Oscl_FileServer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Oscl_FileServer Class Reference<br/>
<small>
[<a class="el" href="group__osclio.html">OSCL IO</a>]</small>
</h1><!-- doxytag: class="Oscl_FileServer" -->
<p><code>#include &lt;<a class="el" href="oscl__file__server_8h_source.html">oscl_file_server.h</a>&gt;</code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileServer.html#acd2a28657db624d44c1c119d0fecba1a">Oscl_FileServer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileServer.html#a6162da888c8e7cb6840437c348677b05">~Oscl_FileServer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileServer.html#aa4d16d941e0b2af37f042e5760264dba">Connect</a> (bool aShareSession=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileServer.html#a6a35c45e2f934622fe201a1a6d68527e">Close</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileServer.html#a91679ecedca9528133394fc3d9b0c660">Oscl_DeleteFile</a> (const char *filename)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileServer.html#a157b0c1975c05bf21ab0ca4439fbbfce">Oscl_DeleteFile</a> (const <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *filename)</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileServer.html#a5fba3c0361d0b14a243a8f6cfd35ac62">Oscl_File</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileServer.html#ae30fae8a2b12272d1588ec15964e1c27">OsclNativeFile</a></td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="acd2a28657db624d44c1c119d0fecba1a"></a><!-- doxytag: member="Oscl_FileServer::Oscl_FileServer" ref="acd2a28657db624d44c1c119d0fecba1a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF Oscl_FileServer::Oscl_FileServer </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor </p>

</div>
</div>
<a class="anchor" id="a6162da888c8e7cb6840437c348677b05"></a><!-- doxytag: member="Oscl_FileServer::~Oscl_FileServer" ref="a6162da888c8e7cb6840437c348677b05" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF Oscl_FileServer::~Oscl_FileServer </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6a35c45e2f934622fe201a1a6d68527e"></a><!-- doxytag: member="Oscl_FileServer::Close" ref="a6a35c45e2f934622fe201a1a6d68527e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF int32 Oscl_FileServer::Close </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Closes a file server.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns 0 on success and a non-zero value otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="aa4d16d941e0b2af37f042e5760264dba"></a><!-- doxytag: member="Oscl_FileServer::Connect" ref="aa4d16d941e0b2af37f042e5760264dba" args="(bool aShareSession=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF int32 Oscl_FileServer::Connect </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>aShareSession</em> = <code>false</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Connects the server. This must be called before a file server can be used.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns 0 on success and a non-zero value otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="a157b0c1975c05bf21ab0ca4439fbbfce"></a><!-- doxytag: member="Oscl_FileServer::Oscl_DeleteFile" ref="a157b0c1975c05bf21ab0ca4439fbbfce" args="(const oscl_wchar *filename)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF int32 Oscl_FileServer::Oscl_DeleteFile </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *&nbsp;</td>
          <td class="paramname"> <em>filename</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Deletes a file from the filesystem</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>name of the file to delete (Unicode)</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns 0 if successful, and a non-zero value otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="a91679ecedca9528133394fc3d9b0c660"></a><!-- doxytag: member="Oscl_FileServer::Oscl_DeleteFile" ref="a91679ecedca9528133394fc3d9b0c660" args="(const char *filename)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF int32 Oscl_FileServer::Oscl_DeleteFile </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>filename</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Deletes a file from the filesystem * </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>name of the file to delete (Utf8)</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns 0 if successful, and a non-zero value otherwise. </dd></dl>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a5fba3c0361d0b14a243a8f6cfd35ac62"></a><!-- doxytag: member="Oscl_FileServer::Oscl_File" ref="a5fba3c0361d0b14a243a8f6cfd35ac62" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classOscl__File.html">Oscl_File</a><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ae30fae8a2b12272d1588ec15964e1c27"></a><!-- doxytag: member="Oscl_FileServer::OsclNativeFile" ref="ae30fae8a2b12272d1588ec15964e1c27" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classOsclNativeFile.html">OsclNativeFile</a><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__file__server_8h_source.html">oscl_file_server.h</a></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.004.1.1 </small>
</small></address>
</body>
</html>