<html>
<head>
<title>Global Functions in Namespace in Sourcefile file.h</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="navimainnone"> 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"></table>
<hr>
<div class="title"><h2>Global Functions in Global Namespace C++<br>
in Sourcefile file.h</h2>
</div><hr>
<dl class="member">
<dt class="member"><a name="osl_abbreviateSystemPath-682"> </a>osl_abbreviateSystemPath</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_abbreviateSystemPath</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> ustrSystemPath,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>pustrCompacted,</td>
</tr>
<tr>
<td><a href="t-sal_uInt32.html">sal_uInt32</a></td>
<td>uMaxWidth,</td>
</tr>
<tr>
<td>oslCalcTextWidthFunc</td>
<td>pCalcWidth );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Abbreviate a system notation path.
</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">ustrSystemPath</td>
<td><pre>
The full system path to abbreviate
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pustrCompacted</td>
<td><pre>
Receives the compacted system path on output
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pfnCalcWidth</td>
<td><pre>
Function ptr that calculates the width of a string. Can be zero.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uMaxWidth</td>
<td><pre>
Maximum width allowed that is retunrned from pfnCalcWidth.
If pfnCalcWidth is zero the character count is assumed as width.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
</dd>
<dt>See Also</dt>
<dd>oslCalcTextWidthFunc <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_acquireDirectoryItem-614"> </a>osl_acquireDirectoryItem</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_acquireDirectoryItem</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslDirectoryItem.html">oslDirectoryItem</a> </td>
<td> Item );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Increase the refcount of a directory item handle.
</dd>
<dt>Description</dt>
<dd>The caller responsible for releasing the directory item handle using osl_releaseDirectoryItem().
</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">Item</td>
<td><pre>
A handle received by a call to osl_getDirectoryItem() or osl_getNextDirectoryItem().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_NOMEM not enough memory for allocating structures<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getDirectoryItem-613">osl_getDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_getNextDirectoryItem-611">osl_getNextDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_releaseDirectoryItem-615">osl_releaseDirectoryItem()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_acquireVolumeDeviceHandle-644"> </a>osl_acquireVolumeDeviceHandle</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_acquireVolumeDeviceHandle</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslVolumeDeviceHandle.html">oslVolumeDeviceHandle</a> </td>
<td> Handle );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Acquire a volume device handle.
</dd>
<dt>Description</dt>
<dd> Acquires the given oslVolumeDeviceHandle which was acquired by a call to
osl_getVolumeInformation(). The caller is responsible for releasing the
acquired handle by calling osl_releaseVolumeDeviceHandle().
</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">Handle</td>
<td><pre>
An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
</dd>
<dt>Todos</dt>
<dd>
specify all error codes that may be returned
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getVolumeInformation-658">osl_getVolumeInformation()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_automountVolumeDevice-642"> </a>osl_automountVolumeDevice</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_automountVolumeDevice</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslVolumeDeviceHandle.html">oslVolumeDeviceHandle</a> </td>
<td> Handle );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Automount a volume device.
</dd>
<dt>Description</dt>
<dd> Automount the volume device specified by the given oslVolumeDeviceHandle.
</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">Handle</td>
<td><pre>
An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
</dd>
<dt>Todos</dt>
<dd>
specify all error codes that may be returned
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getVolumeInformation-658">osl_getVolumeInformation()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_closeDirectory-612"> </a>osl_closeDirectory</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_closeDirectory</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslDirectory.html">oslDirectory</a> </td>
<td> Directory );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Release a directory handle.
</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">Directory</td>
<td><pre>
A handle received by a call to osl_openDirectory().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOMEM not enough memory for allocating structures<br>
osl_File_E_BADF invalid oslDirectory parameter<br>
osl_File_E_INTR the function call was interrupted<p>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openDirectory-610">osl_openDirectory()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_closeFile-670"> </a>osl_closeFile</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_closeFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> </td>
<td> Handle );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Close 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">Handle</td>
<td><pre>
Handle to a file received by a previous call to osl_openFile().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_BADF Bad file<br>
osl_File_E_INTR function call was interrupted<br>
osl_File_E_NOLINK link has been severed<br>
osl_File_E_NOSPC no space left on device<br>
osl_File_E_IO on I/O errors<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openFile-660">osl_openFile()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_copyFile-675"> </a>osl_copyFile</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_copyFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrSourceFileURL,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> *</td>
<td>pustrDestFileURL );</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="flagyes">YES</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">pustrSourceFileURL</td>
<td><pre>
Full qualified URL of the source file.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pustrDestFileURL</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>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_ACCES permission denied<br>
osl_File_E_PERM operation not permitted<br>
osl_File_E_NAMETOOLONG file name too long<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_ISDIR is a directory<br>
osl_File_E_ROFS read-only file system<p>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_moveFile-676">osl_moveFile()</a> <br>
<a href="o-file.h.html#osl_removeFile-674">osl_removeFile()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_createDirectory-671"> </a>osl_createDirectory</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_createDirectory</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrDirectoryURL );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Create a directory.
</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">pustrDirectoryURL</td>
<td><pre>
Full qualified URL of the directory to create.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_EXIST file exists<br>
osl_File_E_ACCES permission denied<br>
osl_File_E_NAMETOOLONG file name too long<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_NOTDIR not a directory<br>
osl_File_E_ROFS read-only file system<br>
osl_File_E_NOSPC no space left on device<br>
osl_File_E_DQUOT quota exceeded<br>
osl_File_E_LOOP too many symbolic links encountered<br>
osl_File_E_FAULT bad address<br>
osl_FileE_IO on I/O errors<br>
osl_File_E_MLINK too many links<br>
osl_File_E_MULTIHOP multihop attempted<br>
osl_File_E_NOLINK link has been severed<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_removeDirectory-672">osl_removeDirectory()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_createDirectoryPath-673"> </a>osl_createDirectoryPath</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_createDirectoryPath</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> aDirectoryUrl,</td>
</tr>
<tr>
<td>oslDirectoryCreationCallbackFunc</td>
<td>aDirectoryCreationCallbackFunc,</td>
</tr>
<tr>
<td>void *</td>
<td>pData );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Create a directory path.
</dd>
<dt>Description</dt>
<dd> The osl_createDirectoryPath function creates a specified directory path.
All nonexisting sub directories will be created.
<p><strong>PLEASE NOTE:</strong> You cannot rely on getting the error code
osl_File_E_EXIST for existing directories. Programming against this error
code is in general a strong indication of a wrong usage of osl_createDirectoryPath.</p>
</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">aDirectoryUrl</td>
<td><pre> [in] The absolute file URL of the directory path to create.
A relative file URL will not be accepted.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">aDirectoryCreationFunc</td>
<td><pre> [in] Pointer to a function that will be called synchronously
for each sub directory that was created. The value of this
parameter may be NULL, in this case notifications will not be
sent.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pData</td>
<td><pre> [in] User specified data to be passed to the directory creation
callback function. The value of this parameter may be arbitrary
and will not be interpreted by osl_createDirectoryPath.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
<dl>
<dt>osl_File_E_None</dt>
<dd>On success</dd>
<dt>osl_File_E_INVAL</dt>
<dd>The format of the parameters was not valid</dd>
<dt>osl_File_E_ACCES</dt>
<dd>Permission denied</dd>
<dt>osl_File_E_EXIST</dt>
<dd>The final node of the specified directory path already exist</dd>
<dt>osl_File_E_NAMETOOLONG</dt>
<dd>The name of the specified directory path exceeds the maximum allowed length</dd>
<dt>osl_File_E_NOTDIR</dt>
<dd>A component of the specified directory path already exist as file in any part of the directory path</dd>
<dt>osl_File_E_ROFS</dt>
<dd>Read-only file system</dd>
<dt>osl_File_E_NOSPC</dt>
<dd>No space left on device</dd>
<dt>osl_File_E_DQUOT</dt>
<dd>Quota exceeded</dd>
<dt>osl_File_E_FAULT</dt>
<dd>Bad address</dd>
<dt>osl_File_E_IO</dt>
<dd>I/O error</dd>
<dt>osl_File_E_LOOP</dt>
<dd>Too many symbolic links encountered</dd>
<dt>osl_File_E_NOLINK</dt>
<dd>Link has been severed</dd>
<dt>osl_File_E_invalidError</dt>
<dd>An unknown error occurred</dd>
</dl>
</dd>
<dt>See Also</dt>
<dd>oslDirectoryCreationFunc <br>
<a href="t-oslFileError.html">oslFileError</a> <br>
osl_createDirectory <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_createTempFile-686"> </a>osl_createTempFile</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_createTempFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrDirectoryURL,</td>
</tr>
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> *</td>
<td>pHandle,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>ppustrTempFileURL );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Creates a temporary file in the directory provided by the caller or the
directory returned by osl_getTempDirURL.
</dd>
<dt>Description</dt>
<dd>Creates a temporary file in the directory provided by the caller or the
directory returned by osl_getTempDirURL.
Under UNIX Operating Systems the file will be created with read and write
access for the user exclusively.
If the caller requests only a handle to the open file but not the name of
it, the file will be automatically removed on close else the caller is
responsible for removing the file on success.
</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">pustrDirectoryURL</td>
<td><pre>
Specifies the full qualified URL where the temporary file should be created.
If pustrDirectoryURL is 0 the path returned by osl_getTempDirURL will be used.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pHandle</td>
<td><pre>
On success receives a handle to the open file. If pHandle is 0 the file will
be closed on return, in this case ppustrTempFileURL must not be 0.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ppustrTempFileURL</td>
<td><pre>
On success receives the full qualified URL of the temporary file.
If ppustrTempFileURL is 0 the file will be automatically removed on close,
in this case pHandle must not be 0.
If ppustrTempFileURL is not 0 the caller receives the name of the created
file and is responsible for removing the file, in this case
*ppustrTempFileURL must be 0 or must point to a valid rtl_uString.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success
osl_File_E_INVAL the format of the parameter is invalid
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_ACCES Permission denied
osl_File_E_NOENT No such file or directory
osl_File_E_NOTDIR Not a directory
osl_File_E_ROFS Read-only file system
osl_File_E_NOSPC No space left on device
osl_File_E_DQUOT Quota exceeded
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getTempDirURL-685">osl_getTempDirURL()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getAbsoluteFileURL-678"> </a>osl_getAbsoluteFileURL</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getAbsoluteFileURL</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrBaseDirectoryURL,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> *</td>
<td>pustrRelativeFileURL,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>ppustrAbsoluteFileURL );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Convert a path relative to a given directory into an full qualified file URL.
</dd>
<dt>Description</dt>
<dd>Convert a path relative to a given directory into an full qualified file URL.
The function resolves symbolic links if possible and path ellipses, so on success
the resulting absolute path is fully resolved.
</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">pustrBaseDirectoryURL</td>
<td><pre>
Base directory URL to which the relative path is related to.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pustrRelativeFileURL</td>
<td><pre>
An URL of a file or directory relative to the directory path specified by pustrBaseDirectoryURL
or an absolute path.
If pustrRelativeFileURL denotes an absolute path pustrBaseDirectoryURL will be ignored.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ppustrAbsoluteFileURL</td>
<td><pre>
On success it receives the full qualified absoulte file URL.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_NOTDIR not a directory<br>
osl_File_E_ACCES permission denied<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_NAMETOOLONG file name too long<br>
osl_File_E_OVERFLOW value too large for defined data type<br>
osl_File_E_FAULT bad address<br>
osl_File_E_INTR function call was interrupted<br>
osl_File_E_LOOP too many symbolic links encountered<br>
osl_File_E_MULTIHOP multihop attempted<br>
osl_File_E_NOLINK link has been severed<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getFileStatus-639">osl_getFileStatus()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getCanonicalName-677"> </a>osl_getCanonicalName</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getCanonicalName</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrRequestedURL,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>ppustrValidURL );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Determine a valid unused canonical name for a requested name.
</dd>
<dt>Description</dt>
<dd> Determines a valid unused canonical name for a requested name.
Depending on the Operating System and the File System the illegal characters are replaced by valid ones.
If a file or directory with the requested name already exists a new name is generated following
the common rules on the actual Operating System and File System.
</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">pustrRequestedURL</td>
<td><pre>
Requested name of a file or directory.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ppustrValidURL</td>
<td><pre>
On success receives a name which is unused and valid on the actual Operating System and
File System.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getFileStatus-639">osl_getFileStatus()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getDirectoryItem-613"> </a>osl_getDirectoryItem</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getDirectoryItem</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrFileURL,</td>
</tr>
<tr>
<td><a href="t-oslDirectoryItem.html">oslDirectoryItem</a> *</td>
<td>pItem );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieve a single directory item.
</dd>
<dt>Description</dt>
<dd> Retrieves a single directory item. The returned handle has an initial refcount of 1.
Due to performance issues it is not recommended to use this function while
enumerating the contents of a directory. In this case use osl_getNextDirectoryItem() instead.
</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">pustrFileURL</td>
<td><pre>
An absolute file URL.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pItem</td>
<td><pre>
On success it receives a handle which can be used for subsequent calls to osl_getFileStatus().
The handle has to be released by a call to osl_releaseDirectoryItem().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_ACCES permission denied<br>
osl_File_E_MFILE too many open files used by the process<br>
osl_File_E_NFILE too many open files in the system<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_LOOP too many symbolic links encountered<br>
osl_File_E_NAMETOOLONG the file name is too long<br>
osl_File_E_NOTDIR a component of the path prefix of path is not a directory<br>
osl_File_E_IO on I/O errors<br>
osl_File_E_MULTIHOP multihop attempted<br>
osl_File_E_NOLINK link has been severed<br>
osl_File_E_FAULT bad address<br>
osl_File_E_INTR the function call was interrupted<p>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_releaseDirectoryItem-615">osl_releaseDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_acquireDirectoryItem-614">osl_acquireDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_getFileStatus-639">osl_getFileStatus()</a> <br>
<a href="o-file.h.html#osl_getNextDirectoryItem-611">osl_getNextDirectoryItem()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getFilePos-662"> </a>osl_getFilePos</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getFilePos</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> </td>
<td> Handle,</td>
</tr>
<tr>
<td><a href="t-sal_uInt64.html">sal_uInt64</a> *</td>
<td>pPos );</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="flagyes">YES</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">Handle</td>
<td><pre>
Handle to a file received by a previous call to osl_openFile().
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pPos</td>
<td><pre>
On success receives the current position of the file pointer.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openFile-660">osl_openFile()</a> <br>
<a href="o-file.h.html#osl_setFilePos-661">osl_setFilePos()</a> <br>
<a href="o-file.h.html#osl_readFile-665">osl_readFile()</a> <br>
<a href="o-file.h.html#osl_writeFile-667">osl_writeFile()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getFileSize-664"> </a>osl_getFileSize</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getFileSize</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> </td>
<td> Handle,</td>
</tr>
<tr>
<td><a href="t-sal_uInt64.html">sal_uInt64</a> *</td>
<td>pSize );</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="flagyes">YES</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">Handle</td>
<td><pre>
Handle to a file received by a previous call to osl_openFile().
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pSize</td>
<td><pre>
Current size in bytes.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openFile-660">osl_openFile()</a> <br>
<a href="o-file.h.html#osl_setFilePos-661">osl_setFilePos()</a> <br>
<a href="o-file.h.html#osl_getFileStatus-639">osl_getFileStatus()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getFileStatus-639"> </a>osl_getFileStatus</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getFileStatus</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslDirectoryItem.html">oslDirectoryItem</a> </td>
<td> Item,</td>
</tr>
<tr>
<td><a href="t-oslFileStatus.html">oslFileStatus</a> *</td>
<td>pStatus,</td>
</tr>
<tr>
<td><a href="t-sal_uInt32.html">sal_uInt32</a></td>
<td>uFieldMask );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieve information about a single file or directory.
</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">Item</td>
<td><pre>
A handle received by a previous call to osl_getDirectoryItem() or osl_getNextDirectoryItem().
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pStatus</td>
<td><pre>
Points to a structure which receives the information of the file or directory
represented by the handle Item. The member uStructSize has to be initialized to
sizeof(oslFileStatus) before calling this function.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uFieldMask</td>
<td><pre>
Specifies which fields of the structure pointed to by pStatus are of interest to the caller.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_LOOP too many symbolic links encountered<br>
osl_File_E_ACCES permission denied<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_NAMETOOLONG file name too long<br>
osl_File_E_BADF invalid oslDirectoryItem parameter<br>
osl_File_E_FAULT bad address<br>
osl_File_E_OVERFLOW value too large for defined data type<br>
osl_File_E_INTR function call was interrupted<br>
osl_File_E_NOLINK link has been severed<br>
osl_File_E_MULTIHOP components of path require hopping to multiple remote machines and the file system does not allow it<br>
osl_File_E_MFILE too many open files used by the process<br>
osl_File_E_NFILE too many open files in the system<br>
osl_File_E_NOSPC no space left on device<br>
osl_File_E_NXIO no such device or address<br>
osl_File_E_IO on I/O errors<br>
osl_File_E_NOSYS function not implemented<p>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getDirectoryItem-613">osl_getDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_getNextDirectoryItem-611">osl_getNextDirectoryItem()</a> <br>
<a href="t-oslFileStatus.html">oslFileStatus</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getFileURLFromSystemPath-679"> </a>osl_getFileURLFromSystemPath</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getFileURLFromSystemPath</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrSystemPath,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>ppustrFileURL );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Convert a system dependend path into a file URL.
</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">pustrSystemPath</td>
<td><pre>
A System dependent path of a file or directory.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ppustrFileURL</td>
<td><pre>
On success it receives the file URL.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getSystemPathFromFileURL-681">osl_getSystemPathFromFileURL()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getNextDirectoryItem-611"> </a>osl_getNextDirectoryItem</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getNextDirectoryItem</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslDirectory.html">oslDirectory</a> </td>
<td> Directory,</td>
</tr>
<tr>
<td><a href="t-oslDirectoryItem.html">oslDirectoryItem</a> *</td>
<td>pItem,</td>
</tr>
<tr>
<td><a href="t-sal_uInt32.html">sal_uInt32</a></td>
<td>uHint );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieve the next item of a previously opened directory.
</dd>
<dt>Description</dt>
<dd> Retrieves the next item of a previously opened directory.
All handles have an initial refcount of 1.
</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">Directory</td>
<td><pre>
A directory handle received from a previous call to osl_openDirectory().
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pItem</td>
<td><pre>
On success it receives a handle that can be used for subsequent calls to osl_getFileStatus().
The handle has to be released by a call to osl_releaseDirectoryItem().
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uHint</td>
<td><pre>
With this parameter the caller can tell the implementation that (s)he
is going to call this function uHint times afterwards. This enables the implementation to
get the information for more than one file and cache it until the next calls.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_NOENT no more entries in this directory<br>
osl_File_E_BADF invalid oslDirectory parameter<br>
osl_File_E_OVERFLOW the value too large for defined data type
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_releaseDirectoryItem-615">osl_releaseDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_acquireDirectoryItem-614">osl_acquireDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_getDirectoryItem-613">osl_getDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_getFileStatus-639">osl_getFileStatus()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getSystemPathFromFileURL-681"> </a>osl_getSystemPathFromFileURL</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getSystemPathFromFileURL</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrFileURL,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>ppustrSystemPath );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Convert a file URL into a system dependend path.
</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">pustrFileURL</td>
<td><pre>
A File URL.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ppustrSystemPath</td>
<td><pre>
On success it receives the system path.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success
osl_File_E_INVAL the format of the parameters was not valid
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getFileURLFromSystemPath-679">osl_getFileURLFromSystemPath()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getTempDirURL-685"> </a>osl_getTempDirURL</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getTempDirURL</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * * </td>
<td> pustrTempDirURL );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieves the file URL of the system's temporary directory path
</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">pustrTempDirURL[out]</td>
<td><pre> On success receives the URL of system's temporary directory path.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success
osl_File_E_NOENT no such file or directory not found
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getVolumeDeviceMountPath-645"> </a>osl_getVolumeDeviceMountPath</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getVolumeDeviceMountPath</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslVolumeDeviceHandle.html">oslVolumeDeviceHandle</a> </td>
<td> Handle,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>ppustrDirectoryURL );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Get the full qualified URL where a device is mounted to.
</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">Handle</td>
<td><pre>
An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ppustrDirectoryURL</td>
<td><pre>
Receives the full qualified URL where the device is mounted to.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_ACCES permission denied<br>
osl_File_E_NXIO no such device or address<br>
osl_File_E_NODEV no such device<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_FAULT bad address<br>
osl_FilE_E_INTR function call was interrupted<br>
osl_File_E_IO on I/O errors<br>
osl_File_E_MULTIHOP multihop attempted<br>
osl_File_E_NOLINK link has been severed<br>
osl_File_E_EOVERFLOW value too large for defined data type<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getVolumeInformation-658">osl_getVolumeInformation()</a> <br>
<a href="o-file.h.html#osl_automountVolumeDevice-642">osl_automountVolumeDevice()</a> <br>
<a href="o-file.h.html#osl_unmountVolumeDevice-641">osl_unmountVolumeDevice()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_getVolumeInformation-658"> </a>osl_getVolumeInformation</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_getVolumeInformation</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrDirectoryURL,</td>
</tr>
<tr>
<td><a href="t-oslVolumeInfo.html">oslVolumeInfo</a> *</td>
<td>pInfo,</td>
</tr>
<tr>
<td><a href="t-sal_uInt32.html">sal_uInt32</a></td>
<td>uFieldMask );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieve information about a volume.
</dd>
<dt>Description</dt>
<dd> Retrieves information about a volume. A volume can either be a mount point, a network
resource or a drive depending on Operating System and File System. Before calling this
function osl_getFileStatus() should be called to determine if the type is
osl_file_Type_Volume.
</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">pustrDirectoryURL</td>
<td><pre>
Full qualified URL of the volume
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pInfo</td>
<td><pre>
On success it receives information about the volume.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">uFieldMask</td>
<td><pre>
Specifies which members of the structure should be filled
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOTDIR not a directory<br>
osl_File_E_NAMETOOLONG file name too long<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_ACCES permission denied<br>
osl_File_E_LOOP too many symbolic links encountered<br>
ols_File_E_FAULT Bad address<br>
osl_File_E_IO on I/O errors<br>
osl_File_E_NOSYS function not implemented<br>
osl_File_E_MULTIHOP multihop attempted<br>
osl_File_E_NOLINK link has been severed<br>
osl_File_E_INTR function call was interrupted<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getFileStatus-639">osl_getFileStatus()</a> <br>
<a href="t-oslVolumeInfo.html">oslVolumeInfo</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_isEndOfFile-666"> </a>osl_isEndOfFile</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_isEndOfFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> </td>
<td> Handle,</td>
</tr>
<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="flagno">NO</td>
<td class="flagyes">YES</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">Handle</td>
<td><pre>
Handle to a file received by a previous call to osl_openFile().
</pre></td>
</tr>
<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>
osl_File_E_None on success <br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_INTR function call was interrupted<br>
osl_File_E_IO on I/O errors<br>
osl_File_E_ISDIR is a directory<br>
osl_File_E_BADF bad file<br>
osl_File_E_FAULT bad address<br>
osl_File_E_AGAIN operation would block<br>
osl_File_E_NOLINK link has been severed<p>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openFile-660">osl_openFile()</a> <br>
<a href="o-file.h.html#osl_readFile-665">osl_readFile()</a> <br>
<a href="o-file.h.html#osl_readLine-668">osl_readLine()</a> <br>
<a href="o-file.h.html#osl_setFilePos-661">osl_setFilePos()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_moveFile-676"> </a>osl_moveFile</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_moveFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrSourceFileURL,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> *</td>
<td>pustrDestFileURL );</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="flagyes">YES</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">pustrSourceFileURL</td>
<td><pre>
Full qualified URL of the source file.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pustrDestFileURL</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>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_ACCES permission denied<br>
osl_File_E_PERM operation not permitted<br>
osl_File_E_NAMETOOLONG file name too long<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_ROFS read-only file system<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_copyFile-675">osl_copyFile()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_openDirectory-610"> </a>osl_openDirectory</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_openDirectory</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrDirectoryURL,</td>
</tr>
<tr>
<td><a href="t-oslDirectory.html">oslDirectory</a> *</td>
<td>pDirectory );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Open a directory for enumerating its contents.
</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">pustrDirectoryURL</td>
<td><pre>
The full qualified URL of the directory.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pDirectory</td>
<td><pre>
On success it receives a handle used for subsequent calls by osl_getNextDirectoryItem().
The handle has to be released by a call to osl_closeDirectory().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOENT the specified path doesn't exist<br>
osl_File_E_NOTDIR the specified path is not an directory <br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_ACCES permission denied<br>
osl_File_E_MFILE too many open files used by the process<br>
osl_File_E_NFILE too many open files in the system<br>
osl_File_E_NAMETOOLONG File name too long<br>
osl_File_E_LOOP Too many symbolic links encountered<p>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getNextDirectoryItem-611">osl_getNextDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_closeDirectory-612">osl_closeDirectory()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_openFile-660"> </a>osl_openFile</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_openFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrFileURL,</td>
</tr>
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> *</td>
<td>pHandle,</td>
</tr>
<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="flagno">NO</td>
<td class="flagyes">YES</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">pustrFileURL</td>
<td><pre>
The full qualified URL of the file to open.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pHandle</td>
<td><pre>
On success it receives a handle to the open file.
</pre></td>
</tr>
<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>
osl_File_E_None on success<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NAMETOOLONG pathname was too long<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_ACCES permission denied<br>
osl_File_E_AGAIN a write lock could not be established<br>
osl_File_E_NOTDIR not a directory<br>
osl_File_E_NXIO no such device or address<br>
osl_File_E_NODEV no such device<br>
osl_File_E_ROFS read-only file system<br>
osl_File_E_TXTBSY text file busy<br>
osl_File_E_FAULT bad address<br>
osl_File_E_LOOP too many symbolic links encountered<br>
osl_File_E_NOSPC no space left on device<br>
osl_File_E_ISDIR is a directory<br>
osl_File_E_MFILE too many open files used by the process<br>
osl_File_E_NFILE too many open files in the system<br>
osl_File_E_DQUOT quota exceeded<br>
osl_File_E_EXIST file exists<br>
osl_FilE_E_INTR function call was interrupted<br>
osl_File_E_IO on I/O errors<br>
osl_File_E_MULTIHOP multihop attempted<br>
osl_File_E_NOLINK link has been severed<br>
osl_File_E_EOVERFLOW value too large for defined data type<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_closeFile-670">osl_closeFile()</a> <br>
<a href="o-file.h.html#osl_setFilePos-661">osl_setFilePos()</a> <br>
<a href="o-file.h.html#osl_getFilePos-662">osl_getFilePos()</a> <br>
<a href="o-file.h.html#osl_readFile-665">osl_readFile()</a> <br>
<a href="o-file.h.html#osl_writeFile-667">osl_writeFile()</a> <br>
<a href="o-file.h.html#osl_setFileSize-663">osl_setFileSize()</a> <br>
<a href="o-file.h.html#osl_getFileSize-664">osl_getFileSize()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_readFile-665"> </a>osl_readFile</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_readFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> </td>
<td> Handle,</td>
</tr>
<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> *</td>
<td>pBytesRead );</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="flagyes">YES</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">Handle</td>
<td><pre>
Handle to a file received by a previous call to osl_openFile().
</pre></td>
</tr>
<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">pBytesRead</td>
<td><pre>
On success the number of bytes which have actually been retrieved.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_INTR function call was interrupted<br>
osl_File_E_IO on I/O errors<br>
osl_File_E_ISDIR is a directory<br>
osl_File_E_BADF bad file<br>
osl_File_E_FAULT bad address<br>
osl_File_E_AGAIN operation would block<br>
osl_File_E_NOLINK link has been severed<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openFile-660">osl_openFile()</a> <br>
<a href="o-file.h.html#osl_writeFile-667">osl_writeFile()</a> <br>
<a href="o-file.h.html#osl_readLine-668">osl_readLine()</a> <br>
<a href="o-file.h.html#osl_setFilePos-661">osl_setFilePos()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_readLine-668"> </a>osl_readLine</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_readLine</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> </td>
<td> Handle,</td>
</tr>
<tr>
<td><a href="t-sal_Sequence.html">sal_Sequence</a> * *</td>
<td>ppSequence );</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="flagyes">YES</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">Handle</td>
<td><pre>
Handle to a file received by a previous call to osl_openFile().
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ppSequence</td>
<td><pre>
A pointer pointer to a sal_Sequence that will hold the line read on success.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_INTR function call was interrupted<br>
osl_File_E_IO on I/O errors<br>
osl_File_E_ISDIR is a directory<br>
osl_File_E_BADF bad file<br>
osl_File_E_FAULT bad address<br>
osl_File_E_AGAIN operation would block<br>
osl_File_E_NOLINK link has been severed<p>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openFile-660">osl_openFile()</a> <br>
<a href="o-file.h.html#osl_readFile-665">osl_readFile()</a> <br>
<a href="o-file.h.html#osl_writeFile-667">osl_writeFile()</a> <br>
<a href="o-file.h.html#osl_setFilePos-661">osl_setFilePos()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_releaseDirectoryItem-615"> </a>osl_releaseDirectoryItem</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_releaseDirectoryItem</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslDirectoryItem.html">oslDirectoryItem</a> </td>
<td> Item );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Decrease the refcount of a directory item handle.
</dd>
<dt>Description</dt>
<dd> Decreases the refcount of a directory item handle.
If the refcount reaches 0 the data associated with
this directory item handle will be released.
</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">Item</td>
<td><pre>
A handle received by a call to osl_getDirectoryItem() or osl_getNextDirectoryItem().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_NOMEM not enough memory for allocating structures<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getDirectoryItem-613">osl_getDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_getNextDirectoryItem-611">osl_getNextDirectoryItem()</a> <br>
<a href="o-file.h.html#osl_acquireDirectoryItem-614">osl_acquireDirectoryItem()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_releaseVolumeDeviceHandle-643"> </a>osl_releaseVolumeDeviceHandle</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_releaseVolumeDeviceHandle</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslVolumeDeviceHandle.html">oslVolumeDeviceHandle</a> </td>
<td> Handle );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Release a volume device handle.
</dd>
<dt>Description</dt>
<dd> Releases the given oslVolumeDeviceHandle which was acquired by a call to
osl_getVolumeInformation() or osl_acquireVolumeDeviceHandle().
</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">Handle</td>
<td><pre>
An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
</dd>
<dt>Todos</dt>
<dd>
specify all error codes that may be returned
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_acquireVolumeDeviceHandle-644">osl_acquireVolumeDeviceHandle()</a> <br>
<a href="o-file.h.html#osl_getVolumeInformation-658">osl_getVolumeInformation()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_removeDirectory-672"> </a>osl_removeDirectory</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_removeDirectory</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrDirectoryURL );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Remove an empty directory.
</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">pustrDirectoryURL</td>
<td><pre>
Full qualified URL of the directory.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_PERM operation not permitted<br>
osl_File_E_ACCES permission denied<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_NOTDIR not a directory<br>
osl_File_E_NOTEMPTY directory not empty<br>
osl_File_E_FAULT bad address<br>
osl_File_E_NAMETOOLONG file name too long<br>
osl_File_E_BUSY device or resource busy<br>
osl_File_E_ROFS read-only file system<br>
osl_File_E_LOOP too many symbolic links encountered<br>
osl_File_E_BUSY device or resource busy<br>
osl_File_E_EXIST file exists<br>
osl_File_E_IO on I/O errors<br>
osl_File_E_MULTIHOP multihop attempted<br>
osl_File_E_NOLINK link has been severed<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_createDirectory-671">osl_createDirectory()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_removeFile-674"> </a>osl_removeFile</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_removeFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrFileURL );</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="flagyes">YES</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">pustrFileURL</td>
<td><pre>
Full qualified URL of the file to remove.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOMEM not enough memory for allocating structures <br>
osl_File_E_ACCES permission denied<br>
osl_File_E_PERM operation not permitted<br>
osl_File_E_NAMETOOLONG file name too long<br>
osl_File_E_NOENT no such file or directory<br>
osl_File_E_ISDIR is a directory<br>
osl_File_E_ROFS read-only file system<br>
osl_File_E_FAULT bad address<br>
osl_File_E_LOOP too many symbolic links encountered<br>
osl_File_E_IO on I/O errors<br>
osl_File_E_BUSY device or resource busy<br>
osl_File_E_INTR function call was interrupted<br>
osl_File_E_LOOP too many symbolic links encountered<br>
osl_File_E_MULTIHOP multihop attempted<br>
osl_File_E_NOLINK link has been severed<br>
osl_File_E_TXTBSY text file busy<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openFile-660">osl_openFile()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_searchFileURL-680"> </a>osl_searchFileURL</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_searchFileURL</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrFileName,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> *</td>
<td>pustrSearchPath,</td>
</tr>
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * *</td>
<td>ppustrFileURL );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Searche a full qualified system path or a file URL.
</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">pustrFileName</td>
<td><pre>
A system dependent path, a file URL, a file or relative directory.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pustrSearchPath</td>
<td><pre>
A list of system paths, in which a given file has to be searched. The Notation of a path list is
system dependend, e.g. on UNIX system "/usr/bin:/bin" and on Windows "C:\BIN;C:\BATCH".
These paths are only for the search of a file or a relative path, otherwise it will be ignored.
If pustrSearchPath is NULL or while using the search path the search failed, the function searches for
a matching file in all system directories and in the directories listed in the PATH environment
variable.
The value of an environment variable should be used (e.g. LD_LIBRARY_PATH) if the caller is not
aware of the Operating System and so doesn't know which path list delimiter to use.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ppustrFileURL</td>
<td><pre>
On success it receives the full qualified file URL.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOTDIR not a directory<br>
osl_File_E_NOENT no such file or directory not found<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getFileURLFromSystemPath-679">osl_getFileURLFromSystemPath()</a> <br>
<a href="o-file.h.html#osl_getSystemPathFromFileURL-681">osl_getSystemPathFromFileURL()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_setFileAttributes-683"> </a>osl_setFileAttributes</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_setFileAttributes</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrFileURL,</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="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</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">pustrFileURL</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>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getFileStatus-639">osl_getFileStatus()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_setFilePos-661"> </a>osl_setFilePos</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_setFilePos</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> </td>
<td> Handle,</td>
</tr>
<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="flagno">NO</td>
<td class="flagyes">YES</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">Handle</td>
<td><pre>
Handle to a file received by a previous call to osl_openFile().
</pre></td>
</tr>
<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>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openFile-660">osl_openFile()</a> <br>
<a href="o-file.h.html#osl_getFilePos-662">osl_getFilePos()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_setFileSize-663"> </a>osl_setFileSize</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_setFileSize</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> </td>
<td> Handle,</td>
</tr>
<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="flagno">NO</td>
<td class="flagyes">YES</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">Handle</td>
<td><pre>
Handle to a file received by a previous call to osl_openFile().
</pre></td>
</tr>
<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>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openFile-660">osl_openFile()</a> <br>
<a href="o-file.h.html#osl_setFilePos-661">osl_setFilePos()</a> <br>
<a href="o-file.h.html#osl_getFileStatus-639">osl_getFileStatus()</a> <br>
<a href="o-file.h.html#osl_getFileSize-664">osl_getFileSize()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_setFileTime-684"> </a>osl_setFileTime</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_setFileTime</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-rtl_uString.html">rtl_uString</a> * </td>
<td> pustrFileURL,</td>
</tr>
<tr>
<td>const <a href="t-TimeValue.html">TimeValue</a> *</td>
<td>aCreationTime,</td>
</tr>
<tr>
<td>const <a href="t-TimeValue.html">TimeValue</a> *</td>
<td>aLastAccessTime,</td>
</tr>
<tr>
<td>const <a href="t-TimeValue.html">TimeValue</a> *</td>
<td>aLastWriteTime );</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="flagyes">YES</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">pustrFileURL</td>
<td><pre>
The full qualified URL of the file.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">aCreationTime</td>
<td><pre>
Creation time of the given file.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">aLastAccessTime</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">aLastWriteTime</td>
<td><pre>
Time of the last modifying of the given file.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_NOENT no such file or directory not found<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getFileStatus-639">osl_getFileStatus()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_syncFile-669"> </a>osl_syncFile</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_syncFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> </td>
<td> Handle );</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="flagyes">YES</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>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">Handle</td>
<td><pre> [in] Handle to a file received by a previous call to osl_openFile().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
<dl>
<dt>osl_File_E_None</dt>
<dd>On success</dd>
<dt>osl_File_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>
<dl>
<dt>osl_File_E_BADF</dt>
<dd>The file associated with the given file handle is not open for writing</dd>
<dt>osl_File_E_IO</dt>
<dd>An I/O error occurred</dd>
<dt>osl_File_E_NOSPC</dt>
<dd>There is no enough space on the target device</dd>
<dt>osl_File_E_ROFS</dt>
<dd>The file associated with the given file handle is located on a read only file system</dd>
<dt>osl_File_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_openFile-660">osl_openFile()</a> <br>
<a href="o-file.h.html#osl_writeFile-667">osl_writeFile()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_unmountVolumeDevice-641"> </a>osl_unmountVolumeDevice</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_unmountVolumeDevice</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslVolumeDeviceHandle.html">oslVolumeDeviceHandle</a> </td>
<td> Handle );</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="flagyes">YES</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Unmount a volume device.
</dd>
<dt>Description</dt>
<dd> Unmount the volume specified by the given oslVolumeDeviceHandle.
</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">Handle</td>
<td><pre>
An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
</dd>
<dt>Todos</dt>
<dd>
specify all error codes that may be returned
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_getVolumeInformation-658">osl_getVolumeInformation()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="osl_writeFile-667"> </a>osl_writeFile</dt>
<dd class="member"><dl>
<dt class="simple">extern "C"<br>
<a href="t-oslFileError.html">oslFileError</a> <strong>osl_writeFile</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="t-oslFileHandle.html">oslFileHandle</a> </td>
<td> Handle,</td>
</tr>
<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> *</td>
<td>pBytesWritten );</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="flagyes">YES</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">Handle</td>
<td><pre>
Handle to a file received by a previous call to osl_openFile().
</pre></td>
</tr>
<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">pBytesWritten</td>
<td><pre>
On success the number of bytes which have actually been written.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
osl_File_E_None on success<br>
osl_File_E_INVAL the format of the parameters was not valid<br>
osl_File_E_FBIG file too large<br>
osl_File_E_DQUOT quota exceeded<p>
osl_File_E_AGAIN operation would block<br>
osl_File_E_BADF bad file<br>
osl_File_E_FAULT bad address<br>
osl_File_E_INTR function call was interrupted<br>
osl_File_E_IO on I/O errosr<br>
osl_File_E_NOLCK no record locks available<br>
osl_File_E_NOLINK link has been severed<br>
osl_File_E_NOSPC no space left on device<br>
osl_File_E_NXIO no such device or address<br>
</dd>
<dt>See Also</dt>
<dd><a href="o-file.h.html#osl_openFile-660">osl_openFile()</a> <br>
<a href="o-file.h.html#osl_readFile-665">osl_readFile()</a> <br>
<a href="o-file.h.html#osl_setFilePos-661">osl_setFilePos()</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 © 2008 Sun Microsystems, Inc.</p>
</div> <!-- id="adc-cppref" -->
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
9086
