Home | History | Annotate | Download | only in oscl_html
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
      2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
      3 <title>Oscl_FileServer class Reference</title>
      4 <link href="doxygen.css" rel="stylesheet" type="text/css">
      5 </head><body>
      6 <!-- Generated by Doxygen 1.2.18 -->
      7 <center>
      8 <a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
      9 <hr><h1>Oscl_FileServer Class Reference<br>
     10 <small>
     11 [<a class="el" href="group__osclio.html">OSCL IO</a>]</small>
     12 </h1><code>#include &lt;<a class="el" href="oscl__file__server_8h-source.html">oscl_file_server.h</a>&gt;</code>
     13 <p>
     14 <table border=0 cellpadding=0 cellspacing=0>
     15 <tr><td></td></tr>
     16 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
     17 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF&nbsp;</td><td valign=bottom><a class="el" href="classOscl__FileServer.html#a0">Oscl_FileServer</a> ()</td></tr>
     18 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF&nbsp;</td><td valign=bottom><a class="el" href="classOscl__FileServer.html#a1">~Oscl_FileServer</a> ()</td></tr>
     19 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int32&nbsp;</td><td valign=bottom><a class="el" href="classOscl__FileServer.html#a2">Connect</a> ()</td></tr>
     20 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int32&nbsp;</td><td valign=bottom><a class="el" href="classOscl__FileServer.html#a3">Close</a> ()</td></tr>
     21 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int32&nbsp;</td><td valign=bottom><a class="el" href="classOscl__FileServer.html#a4">Oscl_DeleteFile</a> (const char *filename)</td></tr>
     22 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int32&nbsp;</td><td valign=bottom><a class="el" href="classOscl__FileServer.html#a5">Oscl_DeleteFile</a> (const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *filename)</td></tr>
     23 <tr><td colspan=2><br><h2>Friends</h2></td></tr>
     24 <tr><td nowrap align=right valign=top>class&nbsp;</td><td valign=bottom><a class="el" href="classOscl__FileServer.html#l0">Oscl_File</a></td></tr>
     25 <tr><td nowrap align=right valign=top>class&nbsp;</td><td valign=bottom><a class="el" href="classOscl__FileServer.html#l1">OsclNativeFile</a></td></tr>
     26 </table>
     27 <hr><h2>Constructor &amp; Destructor Documentation</h2>
     28 <a name="a0" doxytag="Oscl_FileServer::Oscl_FileServer"></a><p>
     29 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     30   <tr>
     31     <td class="md">
     32       <table cellpadding="0" cellspacing="0" border="0">
     33         <tr>
     34           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF Oscl_FileServer::Oscl_FileServer </td>
     35           <td class="md" valign="top">(&nbsp;</td>
     36           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     37           <td class="md" valign="top">)&nbsp;</td>
     38           <td class="md" nowrap></td>
     39         </tr>
     40 
     41       </table>
     42     </td>
     43   </tr>
     44 </table>
     45 <table cellspacing=5 cellpadding=0 border=0>
     46   <tr>
     47     <td>
     48       &nbsp;
     49     </td>
     50     <td>
     51 
     52 <p>
     53 Constructor     </td>
     54   </tr>
     55 </table>
     56 <a name="a1" doxytag="Oscl_FileServer::~Oscl_FileServer"></a><p>
     57 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     58   <tr>
     59     <td class="md">
     60       <table cellpadding="0" cellspacing="0" border="0">
     61         <tr>
     62           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF Oscl_FileServer::~Oscl_FileServer </td>
     63           <td class="md" valign="top">(&nbsp;</td>
     64           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     65           <td class="md" valign="top">)&nbsp;</td>
     66           <td class="md" nowrap></td>
     67         </tr>
     68 
     69       </table>
     70     </td>
     71   </tr>
     72 </table>
     73 <table cellspacing=5 cellpadding=0 border=0>
     74   <tr>
     75     <td>
     76       &nbsp;
     77     </td>
     78     <td>
     79 
     80 <p>
     81 Destructor     </td>
     82   </tr>
     83 </table>
     84 <hr><h2>Member Function Documentation</h2>
     85 <a name="a3" doxytag="Oscl_FileServer::Close"></a><p>
     86 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     87   <tr>
     88     <td class="md">
     89       <table cellpadding="0" cellspacing="0" border="0">
     90         <tr>
     91           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 Oscl_FileServer::Close </td>
     92           <td class="md" valign="top">(&nbsp;</td>
     93           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     94           <td class="md" valign="top">)&nbsp;</td>
     95           <td class="md" nowrap></td>
     96         </tr>
     97 
     98       </table>
     99     </td>
    100   </tr>
    101 </table>
    102 <table cellspacing=5 cellpadding=0 border=0>
    103   <tr>
    104     <td>
    105       &nbsp;
    106     </td>
    107     <td>
    108 
    109 <p>
    110 Closes a file server.
    111 <p>
    112 <dl compact><dt><b>Returns: </b></dt><dd>
    113 returns 0 on success and a non-zero value otherwise </dl>    </td>
    114   </tr>
    115 </table>
    116 <a name="a2" doxytag="Oscl_FileServer::Connect"></a><p>
    117 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    118   <tr>
    119     <td class="md">
    120       <table cellpadding="0" cellspacing="0" border="0">
    121         <tr>
    122           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 Oscl_FileServer::Connect </td>
    123           <td class="md" valign="top">(&nbsp;</td>
    124           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    125           <td class="md" valign="top">)&nbsp;</td>
    126           <td class="md" nowrap></td>
    127         </tr>
    128 
    129       </table>
    130     </td>
    131   </tr>
    132 </table>
    133 <table cellspacing=5 cellpadding=0 border=0>
    134   <tr>
    135     <td>
    136       &nbsp;
    137     </td>
    138     <td>
    139 
    140 <p>
    141 Connects the server. This must be called before a file server can be used.
    142 <p>
    143 <dl compact><dt><b>Returns: </b></dt><dd>
    144 returns 0 on success and a non-zero value otherwise </dl>    </td>
    145   </tr>
    146 </table>
    147 <a name="a5" doxytag="Oscl_FileServer::Oscl_DeleteFile"></a><p>
    148 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    149   <tr>
    150     <td class="md">
    151       <table cellpadding="0" cellspacing="0" border="0">
    152         <tr>
    153           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 Oscl_FileServer::Oscl_DeleteFile </td>
    154           <td class="md" valign="top">(&nbsp;</td>
    155           <td class="md" nowrap valign="top">const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *&nbsp;</td>
    156           <td class="mdname1" valign="top" nowrap>&nbsp; <em>filename</em>          </td>
    157           <td class="md" valign="top">)&nbsp;</td>
    158           <td class="md" nowrap></td>
    159         </tr>
    160 
    161       </table>
    162     </td>
    163   </tr>
    164 </table>
    165 <table cellspacing=5 cellpadding=0 border=0>
    166   <tr>
    167     <td>
    168       &nbsp;
    169     </td>
    170     <td>
    171 
    172 <p>
    173 Deletes a file from the filesystem<dl compact><dt><b>Parameters: </b></dt><dd>
    174 <table border=0 cellspacing=2 cellpadding=0>
    175 <tr><td valign=top><em>filename</em>&nbsp;</td><td>
    176 name of the file to delete (Unicode)</td></tr>
    177 </table>
    178 </dl><dl compact><dt><b>Returns: </b></dt><dd>
    179 returns 0 if successful, and a non-zero value otherwise. </dl>    </td>
    180   </tr>
    181 </table>
    182 <a name="a4" doxytag="Oscl_FileServer::Oscl_DeleteFile"></a><p>
    183 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    184   <tr>
    185     <td class="md">
    186       <table cellpadding="0" cellspacing="0" border="0">
    187         <tr>
    188           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 Oscl_FileServer::Oscl_DeleteFile </td>
    189           <td class="md" valign="top">(&nbsp;</td>
    190           <td class="md" nowrap valign="top">const char *&nbsp;</td>
    191           <td class="mdname1" valign="top" nowrap>&nbsp; <em>filename</em>          </td>
    192           <td class="md" valign="top">)&nbsp;</td>
    193           <td class="md" nowrap></td>
    194         </tr>
    195 
    196       </table>
    197     </td>
    198   </tr>
    199 </table>
    200 <table cellspacing=5 cellpadding=0 border=0>
    201   <tr>
    202     <td>
    203       &nbsp;
    204     </td>
    205     <td>
    206 
    207 <p>
    208 Deletes a file from the filesystem * <dl compact><dt><b>Parameters: </b></dt><dd>
    209 <table border=0 cellspacing=2 cellpadding=0>
    210 <tr><td valign=top><em>filename</em>&nbsp;</td><td>
    211 name of the file to delete (Utf8)</td></tr>
    212 </table>
    213 </dl><dl compact><dt><b>Returns: </b></dt><dd>
    214 returns 0 if successful, and a non-zero value otherwise. </dl>    </td>
    215   </tr>
    216 </table>
    217 <hr><h2>Friends And Related Function Documentation</h2>
    218 <a name="l0" doxytag="Oscl_FileServer::Oscl_File"></a><p>
    219 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    220   <tr>
    221     <td class="md">
    222       <table cellpadding="0" cellspacing="0" border="0">
    223         <tr>
    224           <td class="md" nowrap valign="top"> friend class Oscl_File<code> [friend]</code>
    225       </table>
    226     </td>
    227   </tr>
    228 </table>
    229 <table cellspacing=5 cellpadding=0 border=0>
    230   <tr>
    231     <td>
    232       &nbsp;
    233     </td>
    234     <td>
    235 
    236 <p>
    237     </td>
    238   </tr>
    239 </table>
    240 <a name="l1" doxytag="Oscl_FileServer::OsclNativeFile"></a><p>
    241 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    242   <tr>
    243     <td class="md">
    244       <table cellpadding="0" cellspacing="0" border="0">
    245         <tr>
    246           <td class="md" nowrap valign="top"> friend class OsclNativeFile<code> [friend]</code>
    247       </table>
    248     </td>
    249   </tr>
    250 </table>
    251 <table cellspacing=5 cellpadding=0 border=0>
    252   <tr>
    253     <td>
    254       &nbsp;
    255     </td>
    256     <td>
    257 
    258 <p>
    259     </td>
    260   </tr>
    261 </table>
    262 <hr>The documentation for this class was generated from the following file:<ul>
    263 <li><a class="el" href="oscl__file__server_8h-source.html">oscl_file_server.h</a></ul>
    264 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
    265 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
    266 </small></address>
    267 </body>
    268 </html>
    269