blob: 7f93e434576372c19a4594a752cacaa5e9af193b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>oscl_file_manager.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<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; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; </center>
<hr><h1>oscl_file_manager.h</h1><a href="oscl__file__manager_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">// -*- c++ -*-</span>
00002 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
00003
00004 <span class="comment">// O S C L _ F I L E _ M A N A G E R</span>
00005
00006 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
00007
00019 <span class="preprocessor">#ifndef OSCL_FILE_MANAGER_H_INCLUDED</span>
00020 <span class="preprocessor"></span><span class="preprocessor">#define OSCL_FILE_MANAGER_H_INCLUDED</span>
00021 <span class="preprocessor"></span>
00022 <span class="preprocessor">#include "<a class="code" href="oscl__base_8h.html">oscl_base.h</a>"</span>
00023
<a name="l00024"></a><a class="code" href="classOsclFileManager.html">00024</a> <span class="keyword">class </span><a class="code" href="classOsclFileManager.html">OsclFileManager</a>
00025 {
00026 <span class="keyword">public</span>:
<a name="l00027"></a><a class="code" href="classOsclFileManager.html#s6">00027</a> <span class="keyword">typedef</span> <span class="keyword">enum</span>
00028 {
00029 <a class="code" href="classOsclFileManager.html#s6s0">OSCL_FILE_ATTRIBUTE_READONLY</a> = 0x00000001,
00030 <span class="comment">/*</span>
00031 <span class="comment"> The file or directory is read-only. Applications can read the file but cannot write to it or delete it.</span>
00032 <span class="comment"> For a directory, applications cannot delete it.</span>
00033 <span class="comment"> */</span>
00034 <a class="code" href="classOsclFileManager.html#s6s1">OSCL_FILE_ATTRIBUTE_HIDDEN</a> = 0x00000002,
00035 <span class="comment">/*</span>
00036 <span class="comment"> The file or directory is hidden. It is not included in an ordinary directory listing.</span>
00037 <span class="comment"> */</span>
00038 <a class="code" href="classOsclFileManager.html#s6s2">OSCL_FILE_ATTRIBUTE_SYSTEM</a> = 0x00000004,
00039 <span class="comment">/*</span>
00040 <span class="comment"> The file or directory is part of the operating system, or is used exclusively by the operating system.</span>
00041 <span class="comment"> */</span>
00042 <a class="code" href="classOsclFileManager.html#s6s3">OSCL_FILE_ATTRIBUTE_DIRECTORY</a> = 0x00000010,
00043 <span class="comment">/*</span>
00044 <span class="comment"> The handle identifies a directory.</span>
00045 <span class="comment"> */</span>
00046 <a class="code" href="classOsclFileManager.html#s6s4">OSCL_FILE_ATTRIBUTE_ARCHIVE</a> = 0x00000020,
00047 <span class="comment">/*</span>
00048 <span class="comment"> The file or directory is an archive file. Applications use this attribute to mark files for backup or removal.</span>
00049 <span class="comment"> */</span>
00050 <a class="code" href="classOsclFileManager.html#s6s5">OSCL_FILE_ATTRIBUTE_NORMAL</a> = 0x00000080,
00051 <span class="comment">/*</span>
00052 <span class="comment"> The file or directory does not have another attributes set. This attribute is valid only if used alone.</span>
00053 <span class="comment"> */</span>
00054 <span class="comment">//OSCL_FILE_ATTRIBUTE_TEMPORARY = 0x00000100,</span>
00055 <span class="comment">/*</span>
00056 <span class="comment"> The file is being used for temporary storage. File systems avoid writing data back to mass storage</span>
00057 <span class="comment"> if sufficient cache memory is available, because often the application deletes the temporary file</span>
00058 <span class="comment"> shortly after the handle is closed. In that case, the system can entirely avoid writing the data.</span>
00059 <span class="comment"> Otherwise, the data is written after the handle is closed.</span>
00060 <span class="comment"> */</span>
00061 <span class="comment">//OSCL_FILE_ATTRIBUTE_SPARSE_FILE = 0x00000200,</span>
00062 <span class="comment">/*</span>
00063 <span class="comment"> The file is a sparse file.</span>
00064 <span class="comment"> */</span>
00065 <span class="comment">//OSCL_FILE_ATTRIBUTE_REPARSE_POINT = 0x00000400,</span>
00066 <span class="comment">/*</span>
00067 <span class="comment"> The file or directory has an associated reparse point.</span>
00068 <span class="comment"> */</span>
00069 <span class="comment">//OSCL_FILE_ATTRIBUTE_COMPRESSED = 0x00000800,</span>
00070 <span class="comment">/*</span>
00071 <span class="comment"> The file or directory is compressed.</span>
00072 <span class="comment"> For a file, this means that all of the data in the file is compressed.</span>
00073 <span class="comment"> For a directory, this means that compression is the default for newly created files and subdirectories.</span>
00074 <span class="comment"> */</span>
00075
00076 <span class="comment">//OSCL_FILE_ATTRIBUTE_OFFLINE = 0x00001000,</span>
00077 <span class="comment">/*</span>
00078 <span class="comment"> The data of the file is not immediately available. This attribute indicates that the file data has been</span>
00079 <span class="comment"> physically moved to offline storage.This attribute is used by Remote Storage, the hierarchical storage</span>
00080 <span class="comment"> management software. Applications should not arbitrarily change this attribute.</span>
00081 <span class="comment"> */</span>
00082 <span class="comment">//OSCL_FILE_ATTRIBUTE_ENCRYPTED = 0x00004000,</span>
00083 <span class="comment">/*</span>
00084 <span class="comment"> The file or directory is encrypted. For a file, this means that all data in the file is encrypted.</span>
00085 <span class="comment"> For a directory, this means that encryption is the default for newly created files and subdirectories.</span>
00086 <span class="comment"> */</span>
00087 <span class="comment">//OSCL_FILE_ATTRIBUTE_VIRTUAL = 0x00010000</span>
00088 <span class="comment">/*</span>
00089 <span class="comment"> A file is a virtual file.</span>
00090 <span class="comment"> */</span>
00091
00092 } <a class="code" href="classOsclFileManager.html#s6">OSCL_FILE_ATTRIBUTE_TYPE</a>;
00093
00103 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclFileManager.html#d0">OsclGetFileSize</a>(<span class="keyword">const</span> <a class="code" href="group__osclbase.html#a34">oscl_wchar</a>* aFileName, <a class="code" href="group__osclbase.html#a33">uint64</a>&amp; aFileSize);
00104
00113 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclFileManager.html#d0">OsclGetFileSize</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aFileName, <a class="code" href="group__osclbase.html#a33">uint64</a>&amp; aFileSize);
00114
00124 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclFileManager.html#d2">OsclGetFileCreationTime</a>(<span class="keyword">const</span> <a class="code" href="group__osclbase.html#a34">oscl_wchar</a>* aFileName, <a class="code" href="group__osclbase.html#a33">uint64</a>&amp; aFileCreationTime);
00125
00135 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclFileManager.html#d2">OsclGetFileCreationTime</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aFileName, <a class="code" href="group__osclbase.html#a33">uint64</a>&amp; aFileCreationTime);
00136
00147 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclFileManager.html#d4">OsclGetFileLastAccessTime</a>(<span class="keyword">const</span> <a class="code" href="group__osclbase.html#a34">oscl_wchar</a>* aFileName, <a class="code" href="group__osclbase.html#a33">uint64</a>&amp; aFileLastAccessTime);
00157 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclFileManager.html#d4">OsclGetFileLastAccessTime</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aFileName, <a class="code" href="group__osclbase.html#a33">uint64</a>&amp; aFileLastAccessTime);
00158
00167 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclFileManager.html#d6">OsclGetFileLastWriteTime</a>(<span class="keyword">const</span> <a class="code" href="group__osclbase.html#a34">oscl_wchar</a>* aFileName, <a class="code" href="group__osclbase.html#a33">uint64</a>&amp; aFileLastWriteTime);
00168
00177 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclFileManager.html#d6">OsclGetFileLastWriteTime</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aFileName, <a class="code" href="group__osclbase.html#a33">uint64</a>&amp; aFileLastWriteTime);
00178
00188 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclFileManager.html#d8">OsclGetFileAttributes</a>(<span class="keyword">const</span> <a class="code" href="group__osclbase.html#a34">oscl_wchar</a>* aFileName, uint32&amp; aFileAttributes);
00189
00199 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclFileManager.html#d8">OsclGetFileAttributes</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aFileName, uint32&amp; aFileAttributes);
00207 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classOsclFileManager.html#d10">OsclExtractFilenameFromFullpath</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aPath, <span class="keywordtype">char</span>* &amp;aFileName);
00208 <a class="code" href="osclconfig_8h.html#a3">OSCL_IMPORT_REF</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classOsclFileManager.html#d10">OsclExtractFilenameFromFullpath</a>(<span class="keyword">const</span> <a class="code" href="group__osclbase.html#a34">oscl_wchar</a>* aPath, <a class="code" href="group__osclbase.html#a34">oscl_wchar</a>* &amp;aFileName);
00209
00210 <span class="preprocessor">#endif // OSCL_FILE_MANAGER_H_INCLUDED</span>
00211 <span class="preprocessor"></span>
00213 };
</pre></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_8.000.1.1 </small>
</small></address>
</body>
</html>