<!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>OsclNativeFile class Reference</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> <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> <hr><h1>OsclNativeFile Class Reference<br> <small> [<a class="el" href="group__osclio.html">OSCL IO</a>]</small> </h1><code>#include <<a class="el" href="oscl__file__native_8h-source.html">oscl_file_native.h</a>></code> <p> <p>Inheritance diagram for OsclNativeFile: <p><center><img src="classOsclNativeFile.png" usemap="#OsclNativeFile_map" border="0" alt=""></center> <map name="OsclNativeFile_map"> <area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="0,56,103,80"> <area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="0,0,103,24"> </map> <table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a0">OsclNativeFile</a> ()</td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a1">~OsclNativeFile</a> ()</td></tr> <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a2">Open</a> (const <a class="el" href="classOsclFileHandle.html">OsclFileHandle</a> &, uint32 mode, const <a class="el" href="classOsclNativeFileParams.html">OsclNativeFileParams</a> &params, <a class="el" href="classOscl__FileServer.html">Oscl_FileServer</a> &fileserv)</td></tr> <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a3">Open</a> (const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> *filename, uint32 mode, const <a class="el" href="classOsclNativeFileParams.html">OsclNativeFileParams</a> &params, <a class="el" href="classOscl__FileServer.html">Oscl_FileServer</a> &fileserv)</td></tr> <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a4">Open</a> (const char *filename, uint32 mode, const <a class="el" href="classOsclNativeFileParams.html">OsclNativeFileParams</a> &params, <a class="el" href="classOscl__FileServer.html">Oscl_FileServer</a> &fileserv)</td></tr> <tr><td nowrap align=right valign=top>uint32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a5">Read</a> (<a class="el" href="group__osclbase.html#a25">OsclAny</a> *buffer, uint32 size, uint32 numelements)</td></tr> <tr><td nowrap align=right valign=top>uint32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a6">Write</a> (const <a class="el" href="group__osclbase.html#a25">OsclAny</a> *buffer, uint32 size, uint32 numelements)</td></tr> <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a7">Seek</a> (<a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> offset, <a class="el" href="classOscl__File.html#s11">Oscl_File::seek_type</a> origin)</td></tr> <tr><td nowrap align=right valign=top><a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a8">Tell</a> ()</td></tr> <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a9">Flush</a> ()</td></tr> <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a10">EndOfFile</a> ()</td></tr> <tr><td nowrap align=right valign=top><a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a11">Size</a> ()</td></tr> <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a12">Close</a> ()</td></tr> <tr><td nowrap align=right valign=top>uint32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a13">Mode</a> ()</td></tr> <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a14">GetError</a> ()</td></tr> <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a15">ReadAsync</a> (<a class="el" href="group__osclbase.html#a25">OsclAny</a> *buffer, uint32 size, uint32 numelements, <a class="el" href="classOsclAOStatus.html">OsclAOStatus</a> &status)</td></tr> <tr><td nowrap align=right valign=top>uint32 </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a16">GetReadAsyncNumElements</a> ()</td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a17">HasAsyncRead</a> ()</td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOsclNativeFile.html#a18">ReadAsyncCancel</a> ()</td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="OsclNativeFile::OsclNativeFile"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> OsclNativeFile::OsclNativeFile </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a1" doxytag="OsclNativeFile::~OsclNativeFile"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> OsclNativeFile::~OsclNativeFile </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="a12" doxytag="OsclNativeFile::Close"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int32 OsclNativeFile::Close </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a10" doxytag="OsclNativeFile::EndOfFile"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int32 OsclNativeFile::EndOfFile </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a9" doxytag="OsclNativeFile::Flush"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int32 OsclNativeFile::Flush </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a14" doxytag="OsclNativeFile::GetError"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int32 OsclNativeFile::GetError </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a16" doxytag="OsclNativeFile::GetReadAsyncNumElements"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> uint32 OsclNativeFile::GetReadAsyncNumElements </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Get the number of elements read in the last call to ReadAsync. @returns: number of elements read. </td> </tr> </table> <a name="a17" doxytag="OsclNativeFile::HasAsyncRead"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool OsclNativeFile::HasAsyncRead </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> @returns: true if async read is supported natively. </td> </tr> </table> <a name="a13" doxytag="OsclNativeFile::Mode"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> uint32 OsclNativeFile::Mode </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a4" doxytag="OsclNativeFile::Open"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int32 OsclNativeFile::Open </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const char * </td> <td class="mdname" nowrap> <em>filename</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>uint32 </td> <td class="mdname" nowrap> <em>mode</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classOsclNativeFileParams.html">OsclNativeFileParams</a> & </td> <td class="mdname" nowrap> <em>params</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classOscl__FileServer.html">Oscl_FileServer</a> & </td> <td class="mdname" nowrap> <em>fileserv</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a3" doxytag="OsclNativeFile::Open"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int32 OsclNativeFile::Open </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="group__osclbase.html#a32">oscl_wchar</a> * </td> <td class="mdname" nowrap> <em>filename</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>uint32 </td> <td class="mdname" nowrap> <em>mode</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classOsclNativeFileParams.html">OsclNativeFileParams</a> & </td> <td class="mdname" nowrap> <em>params</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classOscl__FileServer.html">Oscl_FileServer</a> & </td> <td class="mdname" nowrap> <em>fileserv</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a2" doxytag="OsclNativeFile::Open"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int32 OsclNativeFile::Open </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classOsclFileHandle.html">OsclFileHandle</a> & </td> <td class="mdname" nowrap> , </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>uint32 </td> <td class="mdname" nowrap> <em>mode</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classOsclNativeFileParams.html">OsclNativeFileParams</a> & </td> <td class="mdname" nowrap> <em>params</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classOscl__FileServer.html">Oscl_FileServer</a> & </td> <td class="mdname" nowrap> <em>fileserv</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a5" doxytag="OsclNativeFile::Read"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> uint32 OsclNativeFile::Read </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__osclbase.html#a25">OsclAny</a> * </td> <td class="mdname" nowrap> <em>buffer</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>uint32 </td> <td class="mdname" nowrap> <em>size</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>uint32 </td> <td class="mdname" nowrap> <em>numelements</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a15" doxytag="OsclNativeFile::ReadAsync"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int32 OsclNativeFile::ReadAsync </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__osclbase.html#a25">OsclAny</a> * </td> <td class="mdname" nowrap> <em>buffer</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>uint32 </td> <td class="mdname" nowrap> <em>size</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>uint32 </td> <td class="mdname" nowrap> <em>numelements</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classOsclAOStatus.html">OsclAOStatus</a> & </td> <td class="mdname" nowrap> <em>status</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Asynchronous read.<dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>buffer:</em> </td><td> data buffer, must be at least size*numelements bytes </td></tr> <tr><td valign=top><em>size:</em> </td><td> size of elements </td></tr> <tr><td valign=top><em>numelements:</em> </td><td> number of elements to read </td></tr> <tr><td valign=top><em>status:</em> </td><td> Request status for asynchronous completion @returns: 0 for success. </td></tr> </table> </dl> </td> </tr> </table> <a name="a18" doxytag="OsclNativeFile::ReadAsyncCancel"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void OsclNativeFile::ReadAsyncCancel </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Cancel any pending async read. </td> </tr> </table> <a name="a7" doxytag="OsclNativeFile::Seek"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int32 OsclNativeFile::Seek </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> </td> <td class="mdname" nowrap> <em>offset</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classOscl__File.html#s11">Oscl_File::seek_type</a> </td> <td class="mdname" nowrap> <em>origin</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a11" doxytag="OsclNativeFile::Size"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> OsclNativeFile::Size </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a8" doxytag="OsclNativeFile::Tell"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> OsclNativeFile::Tell </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a6" doxytag="OsclNativeFile::Write"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> uint32 OsclNativeFile::Write </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="group__osclbase.html#a25">OsclAny</a> * </td> <td class="mdname" nowrap> <em>buffer</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>uint32 </td> <td class="mdname" nowrap> <em>size</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>uint32 </td> <td class="mdname" nowrap> <em>numelements</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="oscl__file__native_8h-source.html">oscl_file_native.h</a></ul> <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> </small></address> </body> </html>