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 IO</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> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9 <hr><h1>OSCL IO</h1><table border=0 cellpadding=0 cellspacing=0> 10 <tr><td></td></tr> 11 <tr><td colspan=2><br><h2>Files</h2></td></tr> 12 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__dns_8h.html">oscl_dns.h</a></td></tr> 13 <tr><td> </td><td><font size=-1><em>The file <a class="el" href="oscl__socket_8h.html">oscl_socket.h</a> defines the OSCL DNS APIs.</em></font><br><br></td></tr> 14 15 <p> 16 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__file__cache_8h.html">oscl_file_cache.h</a></td></tr> 17 <tr><td> </td><td><font size=-1><em>The file <a class="el" href="oscl__file__cache_8h.html">oscl_file_cache.h</a> defines the class <a class="el" href="classOsclFileCache.html">OsclFileCache</a>.</em></font><br><br></td></tr> 18 19 <p> 20 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__file__dir__utils_8h.html">oscl_file_dir_utils.h</a></td></tr> 21 <tr><td> </td><td><font size=-1><em>The file <a class="el" href="oscl__file__dir__utils_8h.html">oscl_file_dir_utils.h</a> defines some unix-style directory ops.</em></font><br><br></td></tr> 22 23 <p> 24 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__file__find_8h.html">oscl_file_find.h</a></td></tr> 25 <tr><td> </td><td><font size=-1><em>The file <a class="el" href="oscl__file__find_8h.html">oscl_file_find.h</a> defines the class <a class="el" href="classOscl__FileFind.html">Oscl_FileFind</a>.</em></font><br><br></td></tr> 26 27 <p> 28 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__file__handle_8h.html">oscl_file_handle.h</a></td></tr> 29 <tr><td> </td><td><font size=-1><em>The file <a class="el" href="oscl__file__handle_8h.html">oscl_file_handle.h</a> defines the class <a class="el" href="classOsclFileHandle.html">OsclFileHandle</a>.</em></font><br><br></td></tr> 30 31 <p> 32 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__file__io_8h.html">oscl_file_io.h</a></td></tr> 33 <tr><td> </td><td><font size=-1><em>The file <a class="el" href="oscl__file__io_8h.html">oscl_file_io.h</a> defines the class <a class="el" href="classOscl__File.html">Oscl_File</a>. This is the public API to the basic file I/O operations.</em></font><br><br></td></tr> 34 35 <p> 36 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__file__native_8h.html">oscl_file_native.h</a></td></tr> 37 <tr><td> </td><td><font size=-1><em>The file <a class="el" href="oscl__file__native_8h.html">oscl_file_native.h</a> defines the class <a class="el" href="classOsclNativeFile.html">OsclNativeFile</a>. This is the porting layer for basic file I/O operations.</em></font><br><br></td></tr> 38 39 <p> 40 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__file__server_8h.html">oscl_file_server.h</a></td></tr> 41 <tr><td> </td><td><font size=-1><em>The file <a class="el" href="oscl__file__server_8h.html">oscl_file_server.h</a> defines the class <a class="el" href="classOscl__FileServer.html">Oscl_FileServer</a>. This is the porting layer for file server implementations.</em></font><br><br></td></tr> 42 43 <p> 44 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__file__stats_8h.html">oscl_file_stats.h</a></td></tr> 45 <tr><td> </td><td><font size=-1><em>File stats class.</em></font><br><br></td></tr> 46 47 <p> 48 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__file__types_8h.html">oscl_file_types.h</a></td></tr> 49 <tr><td> </td><td><font size=-1><em>The file <a class="el" href="oscl__file__types_8h.html">oscl_file_types.h</a> defines some constants and types for file I/O implementations. Anything that needs to be shared across implementation modules can go here.</em></font><br><br></td></tr> 50 51 <p> 52 <tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="oscl__socket_8h.html">oscl_socket.h</a></td></tr> 53 <tr><td> </td><td><font size=-1><em>The file <a class="el" href="oscl__socket_8h.html">oscl_socket.h</a> defines the OSCL Socket APIs.</em></font><br><br></td></tr> 54 55 <p> 56 <tr><td colspan=2><br><h2>Data Structures</h2></td></tr> 57 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOscl__File.html">Oscl_File</a></td></tr> 58 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOscl__FileFind.html">Oscl_FileFind</a></td></tr> 59 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOscl__FileServer.html">Oscl_FileServer</a></td></tr> 60 <tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structoscl__fsstat.html">oscl_fsstat</a></td></tr> 61 <tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structoscl__stat__buf.html">oscl_stat_buf</a></td></tr> 62 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclDNS.html">OsclDNS</a></td></tr> 63 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclDNSObserver.html">OsclDNSObserver</a></td></tr> 64 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclFileCache.html">OsclFileCache</a></td></tr> 65 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclFileHandle.html">OsclFileHandle</a></td></tr> 66 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclFileStats.html">OsclFileStats</a></td></tr> 67 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclFileStatsItem.html">OsclFileStatsItem</a></td></tr> 68 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclNativeFile.html">OsclNativeFile</a></td></tr> 69 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclNativeFileParams.html">OsclNativeFileParams</a></td></tr> 70 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclSocketServ.html">OsclSocketServ</a></td></tr> 71 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclTCPSocket.html">OsclTCPSocket</a></td></tr> 72 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclUDPSocket.html">OsclUDPSocket</a></td></tr> 73 <tr><td colspan=2><br><h2>Defines</h2></td></tr> 74 <tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__osclio.html#a18">TOsclFileOffsetInt32</a> int32</td></tr> 75 <tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__osclio.html#a19">OSCL_FILE_STATS_LOGGER_NODE</a> "<a class="el" href="classOsclFileStats.html">OsclFileStats</a>"</td></tr> 76 <tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__osclio.html#a20">OSCL_IO_FILENAME_MAXLEN</a> 512</td></tr> 77 <tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__osclio.html#a21">OSCL_IO_EXTENSION_MAXLEN</a> 512</td></tr> 78 <tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__osclio.html#a22">OSCL_FILE_WCHAR_PATH_DELIMITER</a> _STRLIT("/")</td></tr> 79 <tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__osclio.html#a23">OSCL_FILE_CHAR_PATH_DELIMITER</a> _STRLIT_CHAR("/")</td></tr> 80 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr> 81 <tr><td nowrap align=right valign=top>typedef <a class="el" href="structoscl__fsstat.html">oscl_fsstat</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a0">OSCL_FSSTAT</a></td></tr> 82 <tr><td nowrap align=right valign=top>typedef <a class="el" href="structoscl__stat__buf.html">oscl_stat_buf</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a1">OSCL_STAT_BUF</a></td></tr> 83 <tr><td nowrap align=right valign=top>typedef FILE * </td><td valign=bottom><a class="el" href="group__osclio.html#a2">TOsclFileHandle</a></td></tr> 84 <tr><td colspan=2><br><h2>Enumerations</h2></td></tr> 85 <tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group__osclio.html#a24">TPVDNSFxn</a> { <a class="el" href="group__osclio.html#a24a0">EPVDNSGetHostByName</a> 86 }</td></tr> 87 <tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group__osclio.html#a25">TPVDNSEvent</a> { <br> 88 <a class="el" href="group__osclio.html#a25a1">EPVDNSSuccess</a>, 89 <a class="el" href="group__osclio.html#a25a2">EPVDNSPending</a>, 90 <a class="el" href="group__osclio.html#a25a3">EPVDNSTimeout</a>, 91 <a class="el" href="group__osclio.html#a25a4">EPVDNSFailure</a>, 92 <br> 93 <a class="el" href="group__osclio.html#a25a5">EPVDNSCancel</a> 94 <br> 95 }</td></tr> 96 <tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group__osclio.html#a26">OSCL_FILEMGMT_PERMS</a> { <a class="el" href="group__osclio.html#a26a2">OSCL_FILEMGMT_PERMS_READ</a> = 0x1, 97 <a class="el" href="group__osclio.html#a26a3">OSCL_FILEMGMT_PERMS_WRITE</a> = 0x2, 98 <a class="el" href="group__osclio.html#a26a4">OSCL_FILEMGMT_PERMS_EXECUTE</a> = 0x4 99 }</td></tr> 100 <tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group__osclio.html#a27">OSCL_FILEMGMT_MODES</a> { <a class="el" href="group__osclio.html#a27a5">OSCL_FILEMGMT_MODE_DIR</a> = 0x1 101 }</td></tr> 102 <tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> { <br> 103 <a class="el" href="group__osclio.html#a28a6">OSCL_FILEMGMT_E_OK</a> = 0, 104 <a class="el" href="group__osclio.html#a28a7">OSCL_FILEMGMT_E_PATH_TOO_LONG</a>, 105 <a class="el" href="group__osclio.html#a28a8">OSCL_FILEMGMT_E_PATH_NOT_FOUND</a>, 106 <a class="el" href="group__osclio.html#a28a9">OSCL_FILEMGMT_E_ALREADY_EXISTS</a>, 107 <br> 108 <a class="el" href="group__osclio.html#a28a10">OSCL_FILEMGMT_E_NOT_EMPTY</a>, 109 <a class="el" href="group__osclio.html#a28a11">OSCL_FILEMGMT_E_PERMISSION_DENIED</a>, 110 <a class="el" href="group__osclio.html#a28a12">OSCL_FILEMGMT_E_NO_MATCH</a>, 111 <a class="el" href="group__osclio.html#a28a13">OSCL_FILEMGMT_E_UNKNOWN</a>, 112 <br> 113 <a class="el" href="group__osclio.html#a28a14">OSCL_FILEMGMT_E_SYS_SPECIFIC</a>, 114 <a class="el" href="group__osclio.html#a28a15">OSCL_FILEMGMT_E_NOT_IMPLEMENTED</a> 115 <br> 116 }</td></tr> 117 <tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group__osclio.html#a29">TOsclFileOp</a> { <br> 118 <a class="el" href="group__osclio.html#a29a2">EOsclFileOp_Open</a>, 119 <a class="el" href="group__osclio.html#a29a3">EOsclFileOp_Close</a>, 120 <a class="el" href="group__osclio.html#a29a4">EOsclFileOp_Read</a>, 121 <a class="el" href="group__osclio.html#a29a5">EOsclFileOp_Write</a>, 122 <br> 123 <a class="el" href="group__osclio.html#a29a6">EOsclFileOp_Seek</a>, 124 <a class="el" href="group__osclio.html#a29a7">EOsclFileOp_Tell</a>, 125 <a class="el" href="group__osclio.html#a29a8">EOsclFileOp_Size</a>, 126 <a class="el" href="group__osclio.html#a29a9">EOsclFileOp_Flush</a>, 127 <br> 128 <a class="el" href="group__osclio.html#a29a10">EOsclFileOp_EndOfFile</a>, 129 <a class="el" href="group__osclio.html#a29a11">EOsclFileOp_NativeOpen</a>, 130 <a class="el" href="group__osclio.html#a29a12">EOsclFileOp_NativeClose</a>, 131 <a class="el" href="group__osclio.html#a29a13">EOsclFileOp_NativeRead</a>, 132 <br> 133 <a class="el" href="group__osclio.html#a29a14">EOsclFileOp_NativeWrite</a>, 134 <a class="el" href="group__osclio.html#a29a15">EOsclFileOp_NativeSeek</a>, 135 <a class="el" href="group__osclio.html#a29a16">EOsclFileOp_NativeTell</a>, 136 <a class="el" href="group__osclio.html#a29a17">EOsclFileOp_NativeSize</a>, 137 <br> 138 <a class="el" href="group__osclio.html#a29a18">EOsclFileOp_NativeFlush</a>, 139 <a class="el" href="group__osclio.html#a29a19">EOsclFileOp_NativeEndOfFile</a>, 140 <a class="el" href="group__osclio.html#a29a20">EOsclFileOp_Last</a> 141 <br> 142 }</td></tr> 143 <tr><td colspan=2><br><h2>Functions</h2></td></tr> 144 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a4">oscl_getcwd</a> (<a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *path, uint32 size)</td></tr> 145 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a5">oscl_getcwd</a> (char *path, uint32 size)</td></tr> 146 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a6">oscl_stat</a> (const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *path, <a class="el" href="group__osclio.html#a1">OSCL_STAT_BUF</a> *statbuf)</td></tr> 147 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a7">oscl_stat</a> (const char *path, <a class="el" href="group__osclio.html#a1">OSCL_STAT_BUF</a> *statbuf)</td></tr> 148 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a8">oscl_mkdir</a> (const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *path)</td></tr> 149 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a9">oscl_mkdir</a> (const char *path)</td></tr> 150 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a10">oscl_rmdir</a> (const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *path)</td></tr> 151 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a11">oscl_rmdir</a> (const char *path)</td></tr> 152 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a12">oscl_chdir</a> (const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *path)</td></tr> 153 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a13">oscl_chdir</a> (const char *path)</td></tr> 154 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a14">oscl_rename</a> (const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *oldpath, const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *newpath)</td></tr> 155 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a15">oscl_rename</a> (const char *oldpath, const char *newpath)</td></tr> 156 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a16">oscl_statfs</a> (<a class="el" href="group__osclio.html#a0">OSCL_FSSTAT</a> *stats, const char *path)</td></tr> 157 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> </td><td valign=bottom><a class="el" href="group__osclio.html#a17">oscl_statfs</a> (<a class="el" href="group__osclio.html#a0">OSCL_FSSTAT</a> *stats, const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *path)</td></tr> 158 </table> 159 <hr><h2>Define Documentation</h2> 160 <a name="a23" doxytag="oscl_file_types.h::OSCL_FILE_CHAR_PATH_DELIMITER"></a><p> 161 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 162 <tr> 163 <td class="md"> 164 <table cellpadding="0" cellspacing="0" border="0"> 165 <tr> 166 <td class="md" nowrap valign="top"> #define OSCL_FILE_CHAR_PATH_DELIMITER _STRLIT_CHAR("/") 167 </table> 168 </td> 169 </tr> 170 </table> 171 <table cellspacing=5 cellpadding=0 border=0> 172 <tr> 173 <td> 174 175 </td> 176 <td> 177 178 <p> 179 </td> 180 </tr> 181 </table> 182 <a name="a19" doxytag="oscl_file_stats.h::OSCL_FILE_STATS_LOGGER_NODE"></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"> #define OSCL_FILE_STATS_LOGGER_NODE "<a class="el" href="classOsclFileStats.html">OsclFileStats</a>" 189 </table> 190 </td> 191 </tr> 192 </table> 193 <table cellspacing=5 cellpadding=0 border=0> 194 <tr> 195 <td> 196 197 </td> 198 <td> 199 200 <p> 201 </td> 202 </tr> 203 </table> 204 <a name="a22" doxytag="oscl_file_types.h::OSCL_FILE_WCHAR_PATH_DELIMITER"></a><p> 205 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 206 <tr> 207 <td class="md"> 208 <table cellpadding="0" cellspacing="0" border="0"> 209 <tr> 210 <td class="md" nowrap valign="top"> #define OSCL_FILE_WCHAR_PATH_DELIMITER _STRLIT("/") 211 </table> 212 </td> 213 </tr> 214 </table> 215 <table cellspacing=5 cellpadding=0 border=0> 216 <tr> 217 <td> 218 219 </td> 220 <td> 221 222 <p> 223 </td> 224 </tr> 225 </table> 226 <a name="a21" doxytag="oscl_file_types.h::OSCL_IO_EXTENSION_MAXLEN"></a><p> 227 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 228 <tr> 229 <td class="md"> 230 <table cellpadding="0" cellspacing="0" border="0"> 231 <tr> 232 <td class="md" nowrap valign="top"> #define OSCL_IO_EXTENSION_MAXLEN 512 233 </table> 234 </td> 235 </tr> 236 </table> 237 <table cellspacing=5 cellpadding=0 border=0> 238 <tr> 239 <td> 240 241 </td> 242 <td> 243 244 <p> 245 </td> 246 </tr> 247 </table> 248 <a name="a20" doxytag="oscl_file_types.h::OSCL_IO_FILENAME_MAXLEN"></a><p> 249 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 250 <tr> 251 <td class="md"> 252 <table cellpadding="0" cellspacing="0" border="0"> 253 <tr> 254 <td class="md" nowrap valign="top"> #define OSCL_IO_FILENAME_MAXLEN 512 255 </table> 256 </td> 257 </tr> 258 </table> 259 <table cellspacing=5 cellpadding=0 border=0> 260 <tr> 261 <td> 262 263 </td> 264 <td> 265 266 <p> 267 </td> 268 </tr> 269 </table> 270 <a name="a18" doxytag="oscl_file_io.h::TOsclFileOffsetInt32"></a><p> 271 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 272 <tr> 273 <td class="md"> 274 <table cellpadding="0" cellspacing="0" border="0"> 275 <tr> 276 <td class="md" nowrap valign="top"> #define TOsclFileOffsetInt32 int32 277 </table> 278 </td> 279 </tr> 280 </table> 281 <table cellspacing=5 cellpadding=0 border=0> 282 <tr> 283 <td> 284 285 </td> 286 <td> 287 288 <p> 289 </td> 290 </tr> 291 </table> 292 <hr><h2>Typedef Documentation</h2> 293 <a name="a0" doxytag="oscl_file_dir_utils.h::OSCL_FSSTAT"></a><p> 294 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 295 <tr> 296 <td class="md"> 297 <table cellpadding="0" cellspacing="0" border="0"> 298 <tr> 299 <td class="md" nowrap valign="top"> typedef struct <a class="el" href="structoscl__fsstat.html">oscl_fsstat</a> OSCL_FSSTAT 300 </table> 301 </td> 302 </tr> 303 </table> 304 <table cellspacing=5 cellpadding=0 border=0> 305 <tr> 306 <td> 307 308 </td> 309 <td> 310 311 <p> 312 </td> 313 </tr> 314 </table> 315 <a name="a1" doxytag="oscl_file_dir_utils.h::OSCL_STAT_BUF"></a><p> 316 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 317 <tr> 318 <td class="md"> 319 <table cellpadding="0" cellspacing="0" border="0"> 320 <tr> 321 <td class="md" nowrap valign="top"> typedef struct <a class="el" href="structoscl__stat__buf.html">oscl_stat_buf</a> OSCL_STAT_BUF 322 </table> 323 </td> 324 </tr> 325 </table> 326 <table cellspacing=5 cellpadding=0 border=0> 327 <tr> 328 <td> 329 330 </td> 331 <td> 332 333 <p> 334 </td> 335 </tr> 336 </table> 337 <a name="a2" doxytag="oscl_file_handle.h::TOsclFileHandle"></a><p> 338 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 339 <tr> 340 <td class="md"> 341 <table cellpadding="0" cellspacing="0" border="0"> 342 <tr> 343 <td class="md" nowrap valign="top"> typedef FILE* TOsclFileHandle 344 </table> 345 </td> 346 </tr> 347 </table> 348 <table cellspacing=5 cellpadding=0 border=0> 349 <tr> 350 <td> 351 352 </td> 353 <td> 354 355 <p> 356 TOsclFileHandle is an OS-native file handle type. With a class-based file API such as Symbian, a class ref is used as a file handle. For most ANSI-style file APIs, a file pointer is used as a file handle. </td> 357 </tr> 358 </table> 359 <hr><h2>Enumeration Type Documentation</h2> 360 <a name="a28" doxytag="oscl_file_dir_utils.h::OSCL_FILEMGMT_ERR_TYPE"></a><p> 361 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 362 <tr> 363 <td class="md"> 364 <table cellpadding="0" cellspacing="0" border="0"> 365 <tr> 366 <td class="md" nowrap valign="top"> enum OSCL_FILEMGMT_ERR_TYPE 367 </table> 368 </td> 369 </tr> 370 </table> 371 <table cellspacing=5 cellpadding=0 border=0> 372 <tr> 373 <td> 374 375 </td> 376 <td> 377 378 <p> 379 <dl compact><dt><b>Enumeration values: </b></dt><dd> 380 <table border=0 cellspacing=2 cellpadding=0> 381 <tr><td valign=top><em><a name="a28a6" doxytag="OSCL_FILEMGMT_E_OK"></a><em>OSCL_FILEMGMT_E_OK</em></em> </td><td> 382 </td></tr> 383 <tr><td valign=top><em><a name="a28a7" doxytag="OSCL_FILEMGMT_E_PATH_TOO_LONG"></a><em>OSCL_FILEMGMT_E_PATH_TOO_LONG</em></em> </td><td> 384 </td></tr> 385 <tr><td valign=top><em><a name="a28a8" doxytag="OSCL_FILEMGMT_E_PATH_NOT_FOUND"></a><em>OSCL_FILEMGMT_E_PATH_NOT_FOUND</em></em> </td><td> 386 </td></tr> 387 <tr><td valign=top><em><a name="a28a9" doxytag="OSCL_FILEMGMT_E_ALREADY_EXISTS"></a><em>OSCL_FILEMGMT_E_ALREADY_EXISTS</em></em> </td><td> 388 </td></tr> 389 <tr><td valign=top><em><a name="a28a10" doxytag="OSCL_FILEMGMT_E_NOT_EMPTY"></a><em>OSCL_FILEMGMT_E_NOT_EMPTY</em></em> </td><td> 390 </td></tr> 391 <tr><td valign=top><em><a name="a28a11" doxytag="OSCL_FILEMGMT_E_PERMISSION_DENIED"></a><em>OSCL_FILEMGMT_E_PERMISSION_DENIED</em></em> </td><td> 392 </td></tr> 393 <tr><td valign=top><em><a name="a28a12" doxytag="OSCL_FILEMGMT_E_NO_MATCH"></a><em>OSCL_FILEMGMT_E_NO_MATCH</em></em> </td><td> 394 </td></tr> 395 <tr><td valign=top><em><a name="a28a13" doxytag="OSCL_FILEMGMT_E_UNKNOWN"></a><em>OSCL_FILEMGMT_E_UNKNOWN</em></em> </td><td> 396 </td></tr> 397 <tr><td valign=top><em><a name="a28a14" doxytag="OSCL_FILEMGMT_E_SYS_SPECIFIC"></a><em>OSCL_FILEMGMT_E_SYS_SPECIFIC</em></em> </td><td> 398 </td></tr> 399 <tr><td valign=top><em><a name="a28a15" doxytag="OSCL_FILEMGMT_E_NOT_IMPLEMENTED"></a><em>OSCL_FILEMGMT_E_NOT_IMPLEMENTED</em></em> </td><td> 400 </td></tr> 401 </table> 402 </dl> 403 </td> 404 </tr> 405 </table> 406 <a name="a27" doxytag="oscl_file_dir_utils.h::OSCL_FILEMGMT_MODES"></a><p> 407 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 408 <tr> 409 <td class="md"> 410 <table cellpadding="0" cellspacing="0" border="0"> 411 <tr> 412 <td class="md" nowrap valign="top"> enum OSCL_FILEMGMT_MODES 413 </table> 414 </td> 415 </tr> 416 </table> 417 <table cellspacing=5 cellpadding=0 border=0> 418 <tr> 419 <td> 420 421 </td> 422 <td> 423 424 <p> 425 <dl compact><dt><b>Enumeration values: </b></dt><dd> 426 <table border=0 cellspacing=2 cellpadding=0> 427 <tr><td valign=top><em><a name="a27a5" doxytag="OSCL_FILEMGMT_MODE_DIR"></a><em>OSCL_FILEMGMT_MODE_DIR</em></em> </td><td> 428 </td></tr> 429 </table> 430 </dl> 431 </td> 432 </tr> 433 </table> 434 <a name="a26" doxytag="oscl_file_dir_utils.h::OSCL_FILEMGMT_PERMS"></a><p> 435 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 436 <tr> 437 <td class="md"> 438 <table cellpadding="0" cellspacing="0" border="0"> 439 <tr> 440 <td class="md" nowrap valign="top"> enum OSCL_FILEMGMT_PERMS 441 </table> 442 </td> 443 </tr> 444 </table> 445 <table cellspacing=5 cellpadding=0 border=0> 446 <tr> 447 <td> 448 449 </td> 450 <td> 451 452 <p> 453 <dl compact><dt><b>Enumeration values: </b></dt><dd> 454 <table border=0 cellspacing=2 cellpadding=0> 455 <tr><td valign=top><em><a name="a26a2" doxytag="OSCL_FILEMGMT_PERMS_READ"></a><em>OSCL_FILEMGMT_PERMS_READ</em></em> </td><td> 456 </td></tr> 457 <tr><td valign=top><em><a name="a26a3" doxytag="OSCL_FILEMGMT_PERMS_WRITE"></a><em>OSCL_FILEMGMT_PERMS_WRITE</em></em> </td><td> 458 </td></tr> 459 <tr><td valign=top><em><a name="a26a4" doxytag="OSCL_FILEMGMT_PERMS_EXECUTE"></a><em>OSCL_FILEMGMT_PERMS_EXECUTE</em></em> </td><td> 460 </td></tr> 461 </table> 462 </dl> 463 </td> 464 </tr> 465 </table> 466 <a name="a29" doxytag="oscl_file_stats.h::TOsclFileOp"></a><p> 467 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 468 <tr> 469 <td class="md"> 470 <table cellpadding="0" cellspacing="0" border="0"> 471 <tr> 472 <td class="md" nowrap valign="top"> enum TOsclFileOp 473 </table> 474 </td> 475 </tr> 476 </table> 477 <table cellspacing=5 cellpadding=0 border=0> 478 <tr> 479 <td> 480 481 </td> 482 <td> 483 484 <p> 485 <dl compact><dt><b>Enumeration values: </b></dt><dd> 486 <table border=0 cellspacing=2 cellpadding=0> 487 <tr><td valign=top><em><a name="a29a2" doxytag="EOsclFileOp_Open"></a><em>EOsclFileOp_Open</em></em> </td><td> 488 </td></tr> 489 <tr><td valign=top><em><a name="a29a3" doxytag="EOsclFileOp_Close"></a><em>EOsclFileOp_Close</em></em> </td><td> 490 </td></tr> 491 <tr><td valign=top><em><a name="a29a4" doxytag="EOsclFileOp_Read"></a><em>EOsclFileOp_Read</em></em> </td><td> 492 </td></tr> 493 <tr><td valign=top><em><a name="a29a5" doxytag="EOsclFileOp_Write"></a><em>EOsclFileOp_Write</em></em> </td><td> 494 </td></tr> 495 <tr><td valign=top><em><a name="a29a6" doxytag="EOsclFileOp_Seek"></a><em>EOsclFileOp_Seek</em></em> </td><td> 496 </td></tr> 497 <tr><td valign=top><em><a name="a29a7" doxytag="EOsclFileOp_Tell"></a><em>EOsclFileOp_Tell</em></em> </td><td> 498 </td></tr> 499 <tr><td valign=top><em><a name="a29a8" doxytag="EOsclFileOp_Size"></a><em>EOsclFileOp_Size</em></em> </td><td> 500 </td></tr> 501 <tr><td valign=top><em><a name="a29a9" doxytag="EOsclFileOp_Flush"></a><em>EOsclFileOp_Flush</em></em> </td><td> 502 </td></tr> 503 <tr><td valign=top><em><a name="a29a10" doxytag="EOsclFileOp_EndOfFile"></a><em>EOsclFileOp_EndOfFile</em></em> </td><td> 504 </td></tr> 505 <tr><td valign=top><em><a name="a29a11" doxytag="EOsclFileOp_NativeOpen"></a><em>EOsclFileOp_NativeOpen</em></em> </td><td> 506 </td></tr> 507 <tr><td valign=top><em><a name="a29a12" doxytag="EOsclFileOp_NativeClose"></a><em>EOsclFileOp_NativeClose</em></em> </td><td> 508 </td></tr> 509 <tr><td valign=top><em><a name="a29a13" doxytag="EOsclFileOp_NativeRead"></a><em>EOsclFileOp_NativeRead</em></em> </td><td> 510 </td></tr> 511 <tr><td valign=top><em><a name="a29a14" doxytag="EOsclFileOp_NativeWrite"></a><em>EOsclFileOp_NativeWrite</em></em> </td><td> 512 </td></tr> 513 <tr><td valign=top><em><a name="a29a15" doxytag="EOsclFileOp_NativeSeek"></a><em>EOsclFileOp_NativeSeek</em></em> </td><td> 514 </td></tr> 515 <tr><td valign=top><em><a name="a29a16" doxytag="EOsclFileOp_NativeTell"></a><em>EOsclFileOp_NativeTell</em></em> </td><td> 516 </td></tr> 517 <tr><td valign=top><em><a name="a29a17" doxytag="EOsclFileOp_NativeSize"></a><em>EOsclFileOp_NativeSize</em></em> </td><td> 518 </td></tr> 519 <tr><td valign=top><em><a name="a29a18" doxytag="EOsclFileOp_NativeFlush"></a><em>EOsclFileOp_NativeFlush</em></em> </td><td> 520 </td></tr> 521 <tr><td valign=top><em><a name="a29a19" doxytag="EOsclFileOp_NativeEndOfFile"></a><em>EOsclFileOp_NativeEndOfFile</em></em> </td><td> 522 </td></tr> 523 <tr><td valign=top><em><a name="a29a20" doxytag="EOsclFileOp_Last"></a><em>EOsclFileOp_Last</em></em> </td><td> 524 </td></tr> 525 </table> 526 </dl> 527 </td> 528 </tr> 529 </table> 530 <a name="a25" doxytag="oscl_dns.h::TPVDNSEvent"></a><p> 531 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 532 <tr> 533 <td class="md"> 534 <table cellpadding="0" cellspacing="0" border="0"> 535 <tr> 536 <td class="md" nowrap valign="top"> enum TPVDNSEvent 537 </table> 538 </td> 539 </tr> 540 </table> 541 <table cellspacing=5 cellpadding=0 border=0> 542 <tr> 543 <td> 544 545 </td> 546 <td> 547 548 <p> 549 <dl compact><dt><b>Enumeration values: </b></dt><dd> 550 <table border=0 cellspacing=2 cellpadding=0> 551 <tr><td valign=top><em><a name="a25a1" doxytag="EPVDNSSuccess"></a><em>EPVDNSSuccess</em></em> </td><td> 552 </td></tr> 553 <tr><td valign=top><em><a name="a25a2" doxytag="EPVDNSPending"></a><em>EPVDNSPending</em></em> </td><td> 554 </td></tr> 555 <tr><td valign=top><em><a name="a25a3" doxytag="EPVDNSTimeout"></a><em>EPVDNSTimeout</em></em> </td><td> 556 </td></tr> 557 <tr><td valign=top><em><a name="a25a4" doxytag="EPVDNSFailure"></a><em>EPVDNSFailure</em></em> </td><td> 558 </td></tr> 559 <tr><td valign=top><em><a name="a25a5" doxytag="EPVDNSCancel"></a><em>EPVDNSCancel</em></em> </td><td> 560 </td></tr> 561 </table> 562 </dl> 563 </td> 564 </tr> 565 </table> 566 <a name="a24" doxytag="oscl_dns.h::TPVDNSFxn"></a><p> 567 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 568 <tr> 569 <td class="md"> 570 <table cellpadding="0" cellspacing="0" border="0"> 571 <tr> 572 <td class="md" nowrap valign="top"> enum TPVDNSFxn 573 </table> 574 </td> 575 </tr> 576 </table> 577 <table cellspacing=5 cellpadding=0 border=0> 578 <tr> 579 <td> 580 581 </td> 582 <td> 583 584 <p> 585 <dl compact><dt><b>Enumeration values: </b></dt><dd> 586 <table border=0 cellspacing=2 cellpadding=0> 587 <tr><td valign=top><em><a name="a24a0" doxytag="EPVDNSGetHostByName"></a><em>EPVDNSGetHostByName</em></em> </td><td> 588 </td></tr> 589 </table> 590 </dl> 591 </td> 592 </tr> 593 </table> 594 <hr><h2>Function Documentation</h2> 595 <a name="a13" doxytag="oscl_file_dir_utils.h::oscl_chdir"></a><p> 596 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 597 <tr> 598 <td class="md"> 599 <table cellpadding="0" cellspacing="0" border="0"> 600 <tr> 601 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_chdir </td> 602 <td class="md" valign="top">( </td> 603 <td class="md" nowrap valign="top">const char * </td> 604 <td class="mdname1" valign="top" nowrap> <em>path</em> </td> 605 <td class="md" valign="top">) </td> 606 <td class="md" nowrap></td> 607 </tr> 608 609 </table> 610 </td> 611 </tr> 612 </table> 613 <table cellspacing=5 cellpadding=0 border=0> 614 <tr> 615 <td> 616 617 </td> 618 <td> 619 620 <p> 621 oscl_chdir changes the current directory to the path given <dl compact><dt><b>Parameters: </b></dt><dd> 622 <table border=0 cellspacing=2 cellpadding=0> 623 <tr><td valign=top><em>character</em> </td><td> 624 path the full path of the directory to change to. </td></tr> 625 </table> 626 </dl><dl compact><dt><b>Returns: </b></dt><dd> 627 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 628 </tr> 629 </table> 630 <a name="a12" doxytag="oscl_file_dir_utils.h::oscl_chdir"></a><p> 631 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 632 <tr> 633 <td class="md"> 634 <table cellpadding="0" cellspacing="0" border="0"> 635 <tr> 636 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_chdir </td> 637 <td class="md" valign="top">( </td> 638 <td class="md" nowrap valign="top">const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> * </td> 639 <td class="mdname1" valign="top" nowrap> <em>path</em> </td> 640 <td class="md" valign="top">) </td> 641 <td class="md" nowrap></td> 642 </tr> 643 644 </table> 645 </td> 646 </tr> 647 </table> 648 <table cellspacing=5 cellpadding=0 border=0> 649 <tr> 650 <td> 651 652 </td> 653 <td> 654 655 <p> 656 oscl_chdir changes the current directory to the path given <dl compact><dt><b>Parameters: </b></dt><dd> 657 <table border=0 cellspacing=2 cellpadding=0> 658 <tr><td valign=top><em>wide</em> </td><td> 659 character path the full path of the directory to change to. </td></tr> 660 </table> 661 </dl><dl compact><dt><b>Returns: </b></dt><dd> 662 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 663 </tr> 664 </table> 665 <a name="a5" doxytag="oscl_file_dir_utils.h::oscl_getcwd"></a><p> 666 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 667 <tr> 668 <td class="md"> 669 <table cellpadding="0" cellspacing="0" border="0"> 670 <tr> 671 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_getcwd </td> 672 <td class="md" valign="top">( </td> 673 <td class="md" nowrap valign="top">char * </td> 674 <td class="mdname" nowrap> <em>path</em>, </td> 675 </tr> 676 <tr> 677 <td></td> 678 <td></td> 679 <td class="md" nowrap>uint32 </td> 680 <td class="mdname" nowrap> <em>size</em></td> 681 </tr> 682 <tr> 683 <td></td> 684 <td class="md">) </td> 685 <td class="md" colspan="2"></td> 686 </tr> 687 688 </table> 689 </td> 690 </tr> 691 </table> 692 <table cellspacing=5 cellpadding=0 border=0> 693 <tr> 694 <td> 695 696 </td> 697 <td> 698 699 <p> 700 oscl_getcwd function can be used to determine the full path name of the current directory. <dl compact><dt><b>Parameters: </b></dt><dd> 701 <table border=0 cellspacing=2 cellpadding=0> 702 <tr><td valign=top><em>pointer</em> </td><td> 703 to character buffer to receive the current directory </td></tr> 704 <tr><td valign=top><em>size</em> </td><td> 705 size of buffer in characters </td></tr> 706 </table> 707 </dl><dl compact><dt><b>Returns: </b></dt><dd> 708 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 709 </tr> 710 </table> 711 <a name="a4" doxytag="oscl_file_dir_utils.h::oscl_getcwd"></a><p> 712 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 713 <tr> 714 <td class="md"> 715 <table cellpadding="0" cellspacing="0" border="0"> 716 <tr> 717 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_getcwd </td> 718 <td class="md" valign="top">( </td> 719 <td class="md" nowrap valign="top"><a class="el" href="group__osclbase.html#a32">oscl_wchar</a> * </td> 720 <td class="mdname" nowrap> <em>path</em>, </td> 721 </tr> 722 <tr> 723 <td></td> 724 <td></td> 725 <td class="md" nowrap>uint32 </td> 726 <td class="mdname" nowrap> <em>size</em></td> 727 </tr> 728 <tr> 729 <td></td> 730 <td class="md">) </td> 731 <td class="md" colspan="2"></td> 732 </tr> 733 734 </table> 735 </td> 736 </tr> 737 </table> 738 <table cellspacing=5 cellpadding=0 border=0> 739 <tr> 740 <td> 741 742 </td> 743 <td> 744 745 <p> 746 oscl_getcwd function can be used to determine the full path name of the current directory. <dl compact><dt><b>Parameters: </b></dt><dd> 747 <table border=0 cellspacing=2 cellpadding=0> 748 <tr><td valign=top><em>pointer</em> </td><td> 749 to wide character buffer to receive the current directory </td></tr> 750 <tr><td valign=top><em>size</em> </td><td> 751 size of buffer in wide characters </td></tr> 752 </table> 753 </dl><dl compact><dt><b>Returns: </b></dt><dd> 754 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 755 </tr> 756 </table> 757 <a name="a9" doxytag="oscl_file_dir_utils.h::oscl_mkdir"></a><p> 758 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 759 <tr> 760 <td class="md"> 761 <table cellpadding="0" cellspacing="0" border="0"> 762 <tr> 763 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_mkdir </td> 764 <td class="md" valign="top">( </td> 765 <td class="md" nowrap valign="top">const char * </td> 766 <td class="mdname1" valign="top" nowrap> <em>path</em> </td> 767 <td class="md" valign="top">) </td> 768 <td class="md" nowrap></td> 769 </tr> 770 771 </table> 772 </td> 773 </tr> 774 </table> 775 <table cellspacing=5 cellpadding=0 border=0> 776 <tr> 777 <td> 778 779 </td> 780 <td> 781 782 <p> 783 oscl_mkdir function creates a directory in the path given <dl compact><dt><b>Parameters: </b></dt><dd> 784 <table border=0 cellspacing=2 cellpadding=0> 785 <tr><td valign=top><em>character</em> </td><td> 786 path the full path of the directory to create. if parts of the path do not exist the function will fail </td></tr> 787 </table> 788 </dl><dl compact><dt><b>Returns: </b></dt><dd> 789 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 790 </tr> 791 </table> 792 <a name="a8" doxytag="oscl_file_dir_utils.h::oscl_mkdir"></a><p> 793 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 794 <tr> 795 <td class="md"> 796 <table cellpadding="0" cellspacing="0" border="0"> 797 <tr> 798 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_mkdir </td> 799 <td class="md" valign="top">( </td> 800 <td class="md" nowrap valign="top">const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> * </td> 801 <td class="mdname1" valign="top" nowrap> <em>path</em> </td> 802 <td class="md" valign="top">) </td> 803 <td class="md" nowrap></td> 804 </tr> 805 806 </table> 807 </td> 808 </tr> 809 </table> 810 <table cellspacing=5 cellpadding=0 border=0> 811 <tr> 812 <td> 813 814 </td> 815 <td> 816 817 <p> 818 oscl_mkdir function creates a directory in the path given <dl compact><dt><b>Parameters: </b></dt><dd> 819 <table border=0 cellspacing=2 cellpadding=0> 820 <tr><td valign=top><em>wide</em> </td><td> 821 character path the full path of the directory to create. if parts of the path do not exist the function will fail </td></tr> 822 </table> 823 </dl><dl compact><dt><b>Returns: </b></dt><dd> 824 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 825 </tr> 826 </table> 827 <a name="a15" doxytag="oscl_file_dir_utils.h::oscl_rename"></a><p> 828 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 829 <tr> 830 <td class="md"> 831 <table cellpadding="0" cellspacing="0" border="0"> 832 <tr> 833 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_rename </td> 834 <td class="md" valign="top">( </td> 835 <td class="md" nowrap valign="top">const char * </td> 836 <td class="mdname" nowrap> <em>oldpath</em>, </td> 837 </tr> 838 <tr> 839 <td></td> 840 <td></td> 841 <td class="md" nowrap>const char * </td> 842 <td class="mdname" nowrap> <em>newpath</em></td> 843 </tr> 844 <tr> 845 <td></td> 846 <td class="md">) </td> 847 <td class="md" colspan="2"></td> 848 </tr> 849 850 </table> 851 </td> 852 </tr> 853 </table> 854 <table cellspacing=5 cellpadding=0 border=0> 855 <tr> 856 <td> 857 858 </td> 859 <td> 860 861 <p> 862 oscl_rmdir removes an empty directory in the path given <dl compact><dt><b>Parameters: </b></dt><dd> 863 <table border=0 cellspacing=2 cellpadding=0> 864 <tr><td valign=top><em>character</em> </td><td> 865 path the full path of the directory to remove. </td></tr> 866 </table> 867 </dl><dl compact><dt><b>Returns: </b></dt><dd> 868 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 869 </tr> 870 </table> 871 <a name="a14" doxytag="oscl_file_dir_utils.h::oscl_rename"></a><p> 872 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 873 <tr> 874 <td class="md"> 875 <table cellpadding="0" cellspacing="0" border="0"> 876 <tr> 877 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_rename </td> 878 <td class="md" valign="top">( </td> 879 <td class="md" nowrap valign="top">const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> * </td> 880 <td class="mdname" nowrap> <em>oldpath</em>, </td> 881 </tr> 882 <tr> 883 <td></td> 884 <td></td> 885 <td class="md" nowrap>const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> * </td> 886 <td class="mdname" nowrap> <em>newpath</em></td> 887 </tr> 888 <tr> 889 <td></td> 890 <td class="md">) </td> 891 <td class="md" colspan="2"></td> 892 </tr> 893 894 </table> 895 </td> 896 </tr> 897 </table> 898 <table cellspacing=5 cellpadding=0 border=0> 899 <tr> 900 <td> 901 902 </td> 903 <td> 904 905 <p> 906 oscl_rename function renames a file or directory <dl compact><dt><b>Parameters: </b></dt><dd> 907 <table border=0 cellspacing=2 cellpadding=0> 908 <tr><td valign=top><em>wide</em> </td><td> 909 character path the full path of the file or directory to rename. </td></tr> 910 <tr><td valign=top><em>wide</em> </td><td> 911 character path the full path the new name for the directory</td></tr> 912 </table> 913 </dl><dl compact><dt><b>Returns: </b></dt><dd> 914 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 915 </tr> 916 </table> 917 <a name="a11" doxytag="oscl_file_dir_utils.h::oscl_rmdir"></a><p> 918 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 919 <tr> 920 <td class="md"> 921 <table cellpadding="0" cellspacing="0" border="0"> 922 <tr> 923 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_rmdir </td> 924 <td class="md" valign="top">( </td> 925 <td class="md" nowrap valign="top">const char * </td> 926 <td class="mdname1" valign="top" nowrap> <em>path</em> </td> 927 <td class="md" valign="top">) </td> 928 <td class="md" nowrap></td> 929 </tr> 930 931 </table> 932 </td> 933 </tr> 934 </table> 935 <table cellspacing=5 cellpadding=0 border=0> 936 <tr> 937 <td> 938 939 </td> 940 <td> 941 942 <p> 943 oscl_rmdir removes an empty directory in the path given <dl compact><dt><b>Parameters: </b></dt><dd> 944 <table border=0 cellspacing=2 cellpadding=0> 945 <tr><td valign=top><em>character</em> </td><td> 946 path the full path of the directory to remove. </td></tr> 947 </table> 948 </dl><dl compact><dt><b>Returns: </b></dt><dd> 949 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 950 </tr> 951 </table> 952 <a name="a10" doxytag="oscl_file_dir_utils.h::oscl_rmdir"></a><p> 953 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 954 <tr> 955 <td class="md"> 956 <table cellpadding="0" cellspacing="0" border="0"> 957 <tr> 958 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_rmdir </td> 959 <td class="md" valign="top">( </td> 960 <td class="md" nowrap valign="top">const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> * </td> 961 <td class="mdname1" valign="top" nowrap> <em>path</em> </td> 962 <td class="md" valign="top">) </td> 963 <td class="md" nowrap></td> 964 </tr> 965 966 </table> 967 </td> 968 </tr> 969 </table> 970 <table cellspacing=5 cellpadding=0 border=0> 971 <tr> 972 <td> 973 974 </td> 975 <td> 976 977 <p> 978 oscl_rmdir function removes and empty directory in the path given <dl compact><dt><b>Parameters: </b></dt><dd> 979 <table border=0 cellspacing=2 cellpadding=0> 980 <tr><td valign=top><em>wide</em> </td><td> 981 character path the full path of the directory to remove. </td></tr> 982 </table> 983 </dl><dl compact><dt><b>Returns: </b></dt><dd> 984 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 985 </tr> 986 </table> 987 <a name="a7" doxytag="oscl_file_dir_utils.h::oscl_stat"></a><p> 988 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 989 <tr> 990 <td class="md"> 991 <table cellpadding="0" cellspacing="0" border="0"> 992 <tr> 993 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_stat </td> 994 <td class="md" valign="top">( </td> 995 <td class="md" nowrap valign="top">const char * </td> 996 <td class="mdname" nowrap> <em>path</em>, </td> 997 </tr> 998 <tr> 999 <td></td> 1000 <td></td> 1001 <td class="md" nowrap><a class="el" href="group__osclio.html#a1">OSCL_STAT_BUF</a> * </td> 1002 <td class="mdname" nowrap> <em>statbuf</em></td> 1003 </tr> 1004 <tr> 1005 <td></td> 1006 <td class="md">) </td> 1007 <td class="md" colspan="2"></td> 1008 </tr> 1009 1010 </table> 1011 </td> 1012 </tr> 1013 </table> 1014 <table cellspacing=5 cellpadding=0 border=0> 1015 <tr> 1016 <td> 1017 1018 </td> 1019 <td> 1020 1021 <p> 1022 oscl_stat function can be used to determine the size of a file in addition to whether the file exists or not <dl compact><dt><b>Parameters: </b></dt><dd> 1023 <table border=0 cellspacing=2 cellpadding=0> 1024 <tr><td valign=top><em>character</em> </td><td> 1025 path the full path of the file to stat. </td></tr> 1026 </table> 1027 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1028 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 1029 </tr> 1030 </table> 1031 <a name="a6" doxytag="oscl_file_dir_utils.h::oscl_stat"></a><p> 1032 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1033 <tr> 1034 <td class="md"> 1035 <table cellpadding="0" cellspacing="0" border="0"> 1036 <tr> 1037 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_stat </td> 1038 <td class="md" valign="top">( </td> 1039 <td class="md" nowrap valign="top">const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> * </td> 1040 <td class="mdname" nowrap> <em>path</em>, </td> 1041 </tr> 1042 <tr> 1043 <td></td> 1044 <td></td> 1045 <td class="md" nowrap><a class="el" href="group__osclio.html#a1">OSCL_STAT_BUF</a> * </td> 1046 <td class="mdname" nowrap> <em>statbuf</em></td> 1047 </tr> 1048 <tr> 1049 <td></td> 1050 <td class="md">) </td> 1051 <td class="md" colspan="2"></td> 1052 </tr> 1053 1054 </table> 1055 </td> 1056 </tr> 1057 </table> 1058 <table cellspacing=5 cellpadding=0 border=0> 1059 <tr> 1060 <td> 1061 1062 </td> 1063 <td> 1064 1065 <p> 1066 oscl_stat function can be used to determine the size of a file in addition to whether the file exists or not <dl compact><dt><b>Parameters: </b></dt><dd> 1067 <table border=0 cellspacing=2 cellpadding=0> 1068 <tr><td valign=top><em>wide</em> </td><td> 1069 character path the full path of the file to stat. </td></tr> 1070 </table> 1071 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1072 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 1073 </tr> 1074 </table> 1075 <a name="a17" doxytag="oscl_file_dir_utils.h::oscl_statfs"></a><p> 1076 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1077 <tr> 1078 <td class="md"> 1079 <table cellpadding="0" cellspacing="0" border="0"> 1080 <tr> 1081 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_statfs </td> 1082 <td class="md" valign="top">( </td> 1083 <td class="md" nowrap valign="top"><a class="el" href="group__osclio.html#a0">OSCL_FSSTAT</a> * </td> 1084 <td class="mdname" nowrap> <em>stats</em>, </td> 1085 </tr> 1086 <tr> 1087 <td></td> 1088 <td></td> 1089 <td class="md" nowrap>const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> * </td> 1090 <td class="mdname" nowrap> <em>path</em></td> 1091 </tr> 1092 <tr> 1093 <td></td> 1094 <td class="md">) </td> 1095 <td class="md" colspan="2"></td> 1096 </tr> 1097 1098 </table> 1099 </td> 1100 </tr> 1101 </table> 1102 <table cellspacing=5 cellpadding=0 border=0> 1103 <tr> 1104 <td> 1105 1106 </td> 1107 <td> 1108 1109 <p> 1110 Oscl_StatFS function populates a general structure describing free space available on a filesystem <dl compact><dt><b>Parameters: </b></dt><dd> 1111 <table border=0 cellspacing=2 cellpadding=0> 1112 <tr><td valign=top><em>stats</em> </td><td> 1113 pointer to structure to hold information </td></tr> 1114 <tr><td valign=top><em>path</em> </td><td> 1115 located in desired filesystem (utf8) Note: If the OS does not support a particular field in the structure, it is set to -1. </td></tr> 1116 </table> 1117 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1118 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 1119 </tr> 1120 </table> 1121 <a name="a16" doxytag="oscl_file_dir_utils.h::oscl_statfs"></a><p> 1122 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1123 <tr> 1124 <td class="md"> 1125 <table cellpadding="0" cellspacing="0" border="0"> 1126 <tr> 1127 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a28">OSCL_FILEMGMT_ERR_TYPE</a> oscl_statfs </td> 1128 <td class="md" valign="top">( </td> 1129 <td class="md" nowrap valign="top"><a class="el" href="group__osclio.html#a0">OSCL_FSSTAT</a> * </td> 1130 <td class="mdname" nowrap> <em>stats</em>, </td> 1131 </tr> 1132 <tr> 1133 <td></td> 1134 <td></td> 1135 <td class="md" nowrap>const char * </td> 1136 <td class="mdname" nowrap> <em>path</em></td> 1137 </tr> 1138 <tr> 1139 <td></td> 1140 <td class="md">) </td> 1141 <td class="md" colspan="2"></td> 1142 </tr> 1143 1144 </table> 1145 </td> 1146 </tr> 1147 </table> 1148 <table cellspacing=5 cellpadding=0 border=0> 1149 <tr> 1150 <td> 1151 1152 </td> 1153 <td> 1154 1155 <p> 1156 Oscl_StatFS function populates a general structure describing free space available on a filesystem <dl compact><dt><b>Parameters: </b></dt><dd> 1157 <table border=0 cellspacing=2 cellpadding=0> 1158 <tr><td valign=top><em>stats</em> </td><td> 1159 pointer to structure to hold information </td></tr> 1160 <tr><td valign=top><em>path</em> </td><td> 1161 located in desired filesystem (utf8) Note: If the OS does not support a particular field in the structure, it is set to -1. </td></tr> 1162 </table> 1163 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1164 OSCL_FILEMGMT_ERR_TYPE, see enumeration for this type. </dl> </td> 1165 </tr> 1166 </table> 1167 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> 1168 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 1169 </small></address> 1170 </body> 1171 </html> 1172
