<html> <head> <title>class File</title> <link rel="stylesheet" type="text/css" href="../../cpp.css"> </head> <body> <div id="adc-cppref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0"> <tr align="center" valign="top"> <td class="navimain"> <a href="../../index.html">Overview</a> </td> <td class="navimain"> <a href="index.html">Namespace</a> </td> <td class="navimainself"> Class </td> <td class="navimain"> <a href="../../index-files/index-1.html">Index</a> </td> <td class="navimain"> <a href="../../help.html">Help</a> </td> </tr> </table> <table class="navisub" cellpadding="0" cellspacing="3"> <tr> <td width="20%"><font size="-2">PUBLIC MEMBERS:</font></td> <td> <font size="-2">CLASSES</font> | <font size="-2">STRUCTS</font> | <font size="-2">UNIONS</font> | <font size="-2">ENUMS</font> | <font size="-2">TYPEDEFS</font> | <a href="#publ_ops"><font size="-2"><b>METHODS</b></font></a> | <a href="#publ_static_ops"><font size="-2"><b>STATIC METHODS</b></font></a> | <font size="-2">DATA</font> | <font size="-2">STATIC DATA</font></td> </tr> <tr> <td width="20%"><font size="-2">PRIVATE MEMBERS:</font></td> <td> <font size="-2">CLASSES</font> | <font size="-2">STRUCTS</font> | <font size="-2">UNIONS</font> | <font size="-2">ENUMS</font> | <font size="-2">TYPEDEFS</font> | <a href="#priv_ops"><font size="-2"><b>METHODS</b></font></a> | <font size="-2">STATIC METHODS</font> | <a href="#priv_vars"><font size="-2"><b>DATA</b></font></a> | <font size="-2">STATIC DATA</font></td> </tr> </table> <hr> <a href="../../names/index.html" alt="Global Namespace in C++"><font size="+1"><b>::</b></font></a> <a href="index.html" alt="namespace"><font size="+1"><b>osl</b></font></a><font size="+1"> :: </font><div class="title"><h2>class File</h2> </div><hr> <dl> <dt>Base Classes</dt> <dd><pre style="font-family:monospace;"> <span class="btpubl"><a href="c-FileBase.html">FileBase</a> (public)</span> | +--<span class="btself">File</span> </pre></dd> </dl> <dl> <dt>Known Derived Classes</dt> <dd>None.</dd> </dl> <br> <table class="flag-table" border="1" cellspacing="0"> <tr> <td width="25%" class="flagname">virtual</td> <td width="25%" class="flagname">abstract</td> <td width="25%" class="flagname">interface</td> <td width="25%" class="flagname">template</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <dl> <dt>Summary</dt> <dd>The file class object provides access to file contents and attributes. </dd> <dt>See Also</dt> <dd><a href="c-Directory.html">Directory</a> <br> <a href="c-DirectoryItem.html">DirectoryItem</a> <br> </dd> </dl> <dl> <dt>File</dt> <dd>file.hxx</dd> </dl> <hr> <dl> <dt class="subtitle"><a name="publ_"><h3>Public Members</h3> </a></dt> <dd><a name="publ_ops"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Methods</h4> </td> </tr> <tr> <td> <br> <a href="File/o.html#File-342">File</a>( const ::rtl::OUString & ustrFileURL );</td> <td width="50%"> Constructor. </td> </tr> <tr> <td> <br> <a href="File/o.html#~File-343">~File</a>( );</td> <td width="50%"> Destructor </td> </tr> <tr> <td>RC <br> <a href="File/o.html#open-344">open</a>( sal_uInt32 uFlags );</td> <td width="50%"> Open a regular file. </td> </tr> <tr> <td>RC <br> <a href="File/o.html#close-345">close</a>( );</td> <td width="50%"> Close an open file. </td> </tr> <tr> <td>RC <br> <a href="File/o.html#setPos-346">setPos</a>( sal_uInt32 uHow, sal_Int64 uPos );</td> <td width="50%"> Set the internal position pointer of an open file. </td> </tr> <tr> <td>RC <br> <a href="File/o.html#getPos-347">getPos</a>( sal_uInt64 & uPos );</td> <td width="50%"> Retrieve the current position of the internal pointer of an open file. </td> </tr> <tr> <td>RC <br> <a href="File/o.html#isEndOfFile-348">isEndOfFile</a>( sal_Bool * pIsEOF );</td> <td width="50%"> Test if the end of a file is reached. </td> </tr> <tr> <td>RC <br> <a href="File/o.html#setSize-349">setSize</a>( sal_uInt64 uSize );</td> <td width="50%"> Set the file size of an open file. </td> </tr> <tr> <td>RC <br> <a href="File/o.html#getSize-350">getSize</a>( sal_uInt64 & rSize );</td> <td width="50%"> Get the file size of an open file. </td> </tr> <tr> <td>RC <br> <a href="File/o.html#read-351">read</a>( void * pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 & rBytesRead );</td> <td width="50%"> Read a number of bytes from a file. </td> </tr> <tr> <td>RC <br> <a href="File/o.html#write-352">write</a>( const void * pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 & rBytesWritten );</td> <td width="50%"> Write a number of bytes to a file. </td> </tr> <tr> <td>RC <br> <a href="File/o.html#readLine-353">readLine</a>( ::rtl::ByteSequence & aSeq );</td> <td width="50%"> Read a line from a file. </td> </tr> <tr> <td>RC <br> <a href="File/o.html#sync-354">sync</a>( ) const;</td> <td width="50%"> Synchronize the memory representation of a file with that on the physical medium. </td> </tr> </table> <hr> <a name="publ_static_ops"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Static Methods</h4> </td> </tr> <tr> <td>static RC <br> <a href="File/o.html#copy-355">copy</a>( const ::rtl::OUString & ustrSourceFileURL, const ::rtl::OUString & ustrDestFileURL );</td> <td width="50%"> Copy a file to a new destination. </td> </tr> <tr> <td>static RC <br> <a href="File/o.html#move-356">move</a>( const ::rtl::OUString & ustrSourceFileURL, const ::rtl::OUString & ustrDestFileURL );</td> <td width="50%"> Move a file or directory to a new destination or renames it. </td> </tr> <tr> <td>static RC <br> <a href="File/o.html#remove-357">remove</a>( const ::rtl::OUString & ustrFileURL );</td> <td width="50%"> Remove a regular file. </td> </tr> <tr> <td>static RC <br> <a href="File/o.html#setAttributes-358">setAttributes</a>( const ::rtl::OUString & ustrFileURL, sal_uInt64 uAttributes );</td> <td width="50%"> Set file attributes. </td> </tr> <tr> <td>static RC <br> <a href="File/o.html#setTime-359">setTime</a>( const ::rtl::OUString & ustrFileURL, const TimeValue & rCreationTime, const TimeValue & rLastAccessTime, const TimeValue & rLastWriteTime );</td> <td width="50%"> Set the file time. </td> </tr> </table> <hr> </dd> </dl> <dl> <dt class="subtitle"><a name="priv_"><h3>Private Members</h3> </a></dt> <dd><a name="priv_ops"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Methods</h4> </td> </tr> <tr> <td> <br> <a href="File/o.html#File-340">File</a>( File & );</td> <td width="50%"> Copy constructor. </td> </tr> <tr> <td>File & <br> <a href="File/o.html#operator=-341">operator=</a>( File & );</td> <td width="50%"> Assginment operator. </td> </tr> </table> <hr> <a name="priv_vars"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Data</h4> </td> </tr> <tr bgcolor="white"> <td><a href="../t-oslFileHandle.html">oslFileHandle</a> <a href="File/d.html#_pData"><strong>_pData;</strong></a></td> <td/></tr> <tr bgcolor="white"> <td>::rtl::<a href="../rtl/c-OUString.html">OUString</a> <a href="File/d.html#_aPath"><strong>_aPath;</strong></a></td> <td/></tr> </table> <hr> </dd> </dl> <a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-cppref" --> </body> </html>