Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 9514

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Methods of 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">&nbsp;<a href="../../../index.html">Overview</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../index.html">Namespace</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../c-File.html">Class</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../../index-files/index-1.html">Index</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../../help.html">Help</a>&nbsp;</td>
</tr>
</table>
<table class="navisub" cellpadding="0" cellspacing="3"></table>
<hr>
<div class="title"><h2>Methods of Class File</h2>
</div><hr>
<dl class="member">
<dt class="member"><a name="File-214"> </a>File</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>File</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../osl/c-File.html">File</a> &amp; </td>
<td>  );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Copy constructor. 
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="operator=-215"> </a>operator=</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/c-File.html">File</a> &amp; <strong>operator=</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../osl/c-File.html">File</a> &amp; </td>
<td>  );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Assginment operator.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="File-216"> </a>File</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>File</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> ustrFileURL );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Constructor.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrFileURL</td>
<td><pre>
        The full qualified URL of the file. Relative paths are not allowed.
    </pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="~File-217"> </a>~File</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>~File</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Destructor
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="open-218"> </a>open</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>open</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../t-sal_uInt32.html">sal_uInt32</a> </td>
<td> uFlags );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Open a regular file.

</dd>
<dt>Description</dt>
<dd>        Open a file. Only regular files    can be openend.
                        
        </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uFlags</td>
<td><pre>
        Specifies the open mode.
        
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success 
        E_NOMEM not enough memory for allocating structures 
        E_INVAL the format of the parameters was not valid
        E_NAMETOOLONG pathname was too long
        E_NOENT no such file or directory
        E_ACCES permission denied
        E_AGAIN a write lock could not be established
        E_NOTDIR not a directory
        E_NXIO no such device or address
        E_NODEV no such device
        E_ROFS read-only file system
        E_TXTBSY text file busy
        E_FAULT bad address
        E_LOOP too many symbolic links encountered
        E_NOSPC no space left on device
        E_ISDIR is a directory
        E_MFILE too many open files used by the process
        E_NFILE too many open files in the system
        E_DQUOT quota exceeded
        E_EXIST file exists
        E_INTR function call was interrupted
        E_IO on I/O errors
        E_MULTIHOP multihop attempted
        E_NOLINK link has been severed
        E_EOVERFLOW value too large for defined data type

        </dd>
<dt>See Also</dt>
<dd><a href="o.html#close-219">close()</a> <br>
<a href="o.html#setPos-220">setPos()</a> <br>
<a href="o.html#getPos-221">getPos()</a> <br>
<a href="o.html#read-225">read()</a> <br>
<a href="o.html#write-226">write()</a> <br>
<a href="o.html#getSize-224">getSize()</a> <br>
<a href="o.html#setSize-223">setSize()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="close-219"> </a>close</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>close</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Close an open file.

</dd>
<dt>Return</dt>
<dd>
E_None on success 
E_INVAL the format of the parameters was not valid    
E_BADF Bad file
E_INTR function call was interrupted
E_NOLINK link has been severed
E_NOSPC no space left on device
E_IO on I/O errors

</dd>
<dt>See Also</dt>
<dd><a href="o.html#open-218">open()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="setPos-220"> </a>setPos</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>setPos</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../t-sal_uInt32.html">sal_uInt32</a> </td>
<td> uHow,</td>
</tr>
<tr>
<td><a href="../../t-sal_Int64.html">sal_Int64</a></td>
<td>uPos );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Set the internal position pointer of an open file.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uHow</td>
<td><pre>
Distance to move the internal position pointer (from uPos).

</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uPos</td>
<td><pre>
Absolute position from the beginning of the file.

</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
E_None on success 
E_INVAL the format of the parameters was not valid
E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files

</dd>
<dt>See Also</dt>
<dd><a href="o.html#open-218">open()</a> <br>
<a href="o.html#getPos-221">getPos()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getPos-221"> </a>getPos</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>getPos</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../t-sal_uInt64.html">sal_uInt64</a> &amp; </td>
<td> uPos );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieve the current position of the internal pointer of an open file.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uPos</td>
<td><pre>
On success receives the current position of the file pointer.

</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
E_None on success 
E_INVAL the format of the parameters was not valid
E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files

</dd>
<dt>See Also</dt>
<dd><a href="o.html#open-218">open()</a> <br>
<a href="o.html#setPos-220">setPos()</a> <br>
<a href="o.html#read-225">read()</a> <br>
<a href="o.html#write-226">write()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="isEndOfFile-222"> </a>isEndOfFile</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>isEndOfFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../t-sal_Bool.html">sal_Bool</a> * </td>
<td> pIsEOF );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Test if the end of a file is reached.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pIsEOF</td>
<td><pre>
Points to a variable that receives the end-of-file status.

</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
E_None on success  
E_INVAL the format of the parameters was not valid
E_INTR function call was interrupted
E_IO on I/O errors
E_ISDIR is a directory
E_BADF bad file
E_FAULT bad address
E_AGAIN operation would block
E_NOLINK link has been severed

</dd>
<dt>See Also</dt>
<dd><a href="o.html#open-218">open()</a> <br>
<a href="o.html#read-225">read()</a> <br>
<a href="o.html#readLine-227">readLine()</a> <br>
<a href="o.html#setPos-220">setPos()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="setSize-223"> </a>setSize</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>setSize</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../t-sal_uInt64.html">sal_uInt64</a> </td>
<td> uSize );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Set the file size of an open file. 

</dd>
<dt>Description</dt>
<dd>        Sets the file size of an open file. The file can be truncated or enlarged by the function.
        The position of the file pointer is not affeced by this function.
                
        </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uSize</td>
<td><pre>
        New size in bytes.
        
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success 
        E_INVAL the format of the parameters was not valid
        E_OVERFLOW the resulting file offset would be a value which cannot    be represented correctly for regular files

        </dd>
<dt>See Also</dt>
<dd><a href="o.html#open-218">open()</a> <br>
<a href="o.html#setPos-220">setPos()</a> <br>
getStatus() <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getSize-224"> </a>getSize</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>getSize</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../t-sal_uInt64.html">sal_uInt64</a> &amp; </td>
<td> rSize );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Get the file size of an open file. 

</dd>
<dt>Description</dt>
<dd>        Gets the file size of an open file. 
        The position of the file pointer is not affeced by this function.
                
        </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rSize</td>
<td><pre>
        Current size in bytes.
        
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success 
        E_INVAL the format of the parameters was not valid
        E_OVERFLOW the resulting file offset would be a value which cannot    be represented correctly for regular files

        </dd>
<dt>See Also</dt>
<dd><a href="o.html#open-218">open()</a> <br>
<a href="o.html#setPos-220">setPos()</a> <br>
<a href="o.html#getSize-224">getSize()</a> <br>
<a href="o.html#setSize-223">setSize()</a> <br>
getStatus() <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="read-225"> </a>read</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>read</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>void * </td>
<td> pBuffer,</td>
</tr>
<tr>
<td><a href="../../t-sal_uInt64.html">sal_uInt64</a></td>
<td>uBytesRequested,</td>
</tr>
<tr>
<td><a href="../../t-sal_uInt64.html">sal_uInt64</a> &amp;</td>
<td>rBytesRead );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Read a number of bytes from a file. 

</dd>
<dt>Description</dt>
<dd>        Reads a number of bytes from a file. The internal file pointer is 
        increased by the number of bytes read.
                
        </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pBuffer</td>
<td><pre>
        Points to a buffer which receives data. The buffer must be large enough    
        to hold uBytesRequested bytes.
        
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uBytesRequested</td>
<td><pre>
        Number of bytes which should be retrieved.
        
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rBytesRead</td>
<td><pre>
        On success the number of bytes which have actually been retrieved.
        
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success
        E_INVAL the format of the parameters was not valid
        E_INTR function call was interrupted
        E_IO on I/O errors
        E_ISDIR is a directory
        E_BADF bad file
        E_FAULT bad address
        E_AGAIN operation would block
        E_NOLINK link has been severed

        </dd>
<dt>See Also</dt>
<dd><a href="o.html#open-218">open()</a> <br>
<a href="o.html#write-226">write()</a> <br>
<a href="o.html#readLine-227">readLine()</a> <br>
<a href="o.html#setPos-220">setPos()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="write-226"> </a>write</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>write</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const void * </td>
<td> pBuffer,</td>
</tr>
<tr>
<td><a href="../../t-sal_uInt64.html">sal_uInt64</a></td>
<td>uBytesToWrite,</td>
</tr>
<tr>
<td><a href="../../t-sal_uInt64.html">sal_uInt64</a> &amp;</td>
<td>rBytesWritten );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Write a number of bytes to a file. 

</dd>
<dt>Description</dt>
<dd>    Writes a number of bytes to a file. 
    The internal file pointer is increased by the number of bytes read.
            
    </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pBuffer</td>
<td><pre>
    Points to a buffer which contains the data.
    
    </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uBytesToWrite</td>
<td><pre>
    Number of bytes which should be written.
    
    </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rBytesWritten</td>
<td><pre>
    On success the number of bytes which have actually been written.

    </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
    E_None on success 
    E_INVAL the format of the parameters was not valid
    E_FBIG file too large
    E_DQUOT quota exceeded
    E_AGAIN operation would block
    E_BADF bad file
    E_FAULT bad address
    E_INTR function call was interrupted
    E_IO on I/O errosr
    E_NOLCK no record locks available
    E_NOLINK link has been severed
    E_NOSPC no space left on device
    E_NXIO no such device or address

    </dd>
<dt>See Also</dt>
<dd><a href="o.html#open-218">open()</a> <br>
<a href="o.html#read-225">read()</a> <br>
<a href="o.html#setPos-220">setPos()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="readLine-227"> </a>readLine</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>readLine</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>::rtl::<a href="../../rtl/c-ByteSequence.html">ByteSequence</a> &amp; </td>
<td> aSeq );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Read a line from a file. 

</dd>
<dt>Description</dt>
<dd>        Reads a line from a file. The new line delimiter is NOT returned!
        
        </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">aSeq</td>
<td><pre>
        A reference to a ::rtl::ByteSequence that will hold the line read on success.
        
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success
        E_INVAL the format of the parameters was not valid
        E_INTR function call was interrupted
        E_IO on I/O errors
        E_ISDIR is a directory
        E_BADF bad file
        E_FAULT bad address
        E_AGAIN operation would block
        E_NOLINK link has been severed

        </dd>
<dt>See Also</dt>
<dd><a href="o.html#open-218">open()</a> <br>
<a href="o.html#read-225">read()</a> <br>
<a href="o.html#write-226">write()</a> <br>
<a href="o.html#setPos-220">setPos()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="sync-228"> </a>sync</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>sync</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Synchronize the memory representation of a file with that on the physical medium.

</dd>
<dt>Description</dt>
<dd>The function ensures that all modified data and attributes of the file associated with 
the given file handle have been written to the physical medium. 
In case the hard disk has a write cache enabled, the data may not really be on 
permanent storage when osl_syncFile returns.

</dd>
<dt>Return</dt>
<dd>
<dl>
<dt>E_None</dt>
<dd>On success</dd>
<dt>E_INVAL</dt>
<dd>The value of the input parameter is invalid</dd>
</dl>
<br><p><strong>In addition to these error codes others may occur as well, for instance:</strong></p><br>
<dt>E_BADF</dt>
<dd>The file is not open for writing</dd>
<dt>E_IO</dt>
<dd>An I/O error occurred</dd>
<dt>E_NOSPC</dt>
<dd>There is no enough space on the target device</dd>
<dt>E_ROFS</dt>
<dd>The file is located on a read only file system</dd>
<dt>E_TIMEDOUT</dt>
<dd>A remote connection timed out. This may happen when a file is on a remote location</dd>
</dl>

</dd>
<dt>See Also</dt>
<dd><a href="../../o-file.h.html#osl_syncFile-664">osl_syncFile()</a> <br>
<a href="o.html#open-218">open()</a> <br>
<a href="o.html#write-226">write()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="copy-229"> </a>copy</dt>
<dd class="member"><dl>
<dt class="simple">static <a href="../../osl/FileBase/e-RC.html">RC</a> <strong>copy</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> ustrSourceFileURL,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>ustrDestFileURL );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Copy a file to a new destination. 

</dd>
<dt>Description</dt>
<dd>        Copies a file to a new destination. Copies only files not directories. 
        No assumptions should be made about preserving attributes or file time.
        
        </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrSourceFileURL</td>
<td><pre>
        Full qualified URL of the source file.
        
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrDestFileURL</td>
<td><pre>
        Full qualified URL of the destination file. A directory is NOT a valid destination file!
        
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success
        E_INVAL the format of the parameters was not valid
        E_NOMEM not enough memory for allocating structures 
        E_ACCES permission denied
        E_PERM operation not permitted
        E_NAMETOOLONG file name too long
        E_NOENT no such file or directory
        E_ISDIR is a directory
        E_ROFS read-only file system

        </dd>
<dt>See Also</dt>
<dd><a href="o.html#move-230">move()</a> <br>
<a href="o.html#remove-231">remove()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="move-230"> </a>move</dt>
<dd class="member"><dl>
<dt class="simple">static <a href="../../osl/FileBase/e-RC.html">RC</a> <strong>move</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> ustrSourceFileURL,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>ustrDestFileURL );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Move a file or directory to a new destination or renames it. 

</dd>
<dt>Description</dt>
<dd>        Moves a file or directory to a new destination or renames it. 
        File time and attributes are preserved.
        
        </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrSourceFileURL</td>
<td><pre>
        Full qualified URL of the source file.
        
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrDestFileURL</td>
<td><pre>
        Full qualified URL of the destination file. An existing directory is NOT a valid destination !
        
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success 
        E_INVAL the format of the parameters was not valid
        E_NOMEM not enough memory for allocating structures 
        E_ACCES permission denied
        E_PERM operation not permitted
        E_NAMETOOLONG file name too long
        E_NOENT no such file or directory
        E_ROFS read-only file system

        </dd>
<dt>See Also</dt>
<dd><a href="o.html#copy-229">copy()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="remove-231"> </a>remove</dt>
<dd class="member"><dl>
<dt class="simple">static <a href="../../osl/FileBase/e-RC.html">RC</a> <strong>remove</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> ustrFileURL );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Remove a regular file.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrFileURL</td>
<td><pre>
        Full qualified URL of the file to remove.
        
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success 
        E_INVAL the format of the parameters was not valid
        E_NOMEM not enough memory for allocating structures 
        E_ACCES permission denied
        E_PERM operation not permitted
        E_NAMETOOLONG file name too long
        E_NOENT no such file or directory
        E_ISDIR is a directory
        E_ROFS read-only file system
        E_FAULT bad address
        E_LOOP too many symbolic links encountered
        E_IO on I/O errors
        E_BUSY device or resource busy
        E_INTR function call was interrupted
        E_LOOP too many symbolic links encountered
        E_MULTIHOP multihop attempted
        E_NOLINK link has been severed
        E_TXTBSY text file busy
        
        </dd>
<dt>See Also</dt>
<dd><a href="o.html#open-218">open()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="setAttributes-232"> </a>setAttributes</dt>
<dd class="member"><dl>
<dt class="simple">static <a href="../../osl/FileBase/e-RC.html">RC</a> <strong>setAttributes</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> ustrFileURL,</td>
</tr>
<tr>
<td><a href="../../t-sal_uInt64.html">sal_uInt64</a></td>
<td>uAttributes );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Set file attributes.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrFileURL</td>
<td><pre>
        The full qualified file URL.
        
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uAttributes</td>
<td><pre>
        Attributes of the file to be set.

        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success 
        E_INVAL the format of the parameters was not valid
        
        </dd>
<dt>See Also</dt>
<dd><a href="../../osl/c-FileStatus.html">FileStatus</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="setTime-233"> </a>setTime</dt>
<dd class="member"><dl>
<dt class="simple">static <a href="../../osl/FileBase/e-RC.html">RC</a> <strong>setTime</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> ustrFileURL,</td>
</tr>
<tr>
<td>const <a href="../../t-TimeValue.html">TimeValue</a> &amp;</td>
<td>rCreationTime,</td>
</tr>
<tr>
<td>const <a href="../../t-TimeValue.html">TimeValue</a> &amp;</td>
<td>rLastAccessTime,</td>
</tr>
<tr>
<td>const <a href="../../t-TimeValue.html">TimeValue</a> &amp;</td>
<td>rLastWriteTime );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Set the file time.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrFileURL</td>
<td><pre>
        The full qualified URL of the file.
        
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rCreationTime</td>
<td><pre>
        Creation time of the given file.
        
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rLastAccessTime</td>
<td><pre>
        Time of the last access of the given file.
        
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rLastWriteTime</td>
<td><pre>
        Time of the last modifying of the given file.

        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success
        E_INVAL the format of the parameters was not valid
        E_NOENT no such file or directory not found
        
        </dd>
<dt>See Also</dt>
<dd><a href="../../osl/c-FileStatus.html">FileStatus</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-cppref" -->
</body>

</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional