| <html> |
| <head> |
| <title>Global Functions in Namespace in Sourcefile file.h</title> |
| <style> h1 { font-size:20pt; margin-top:3pt; margin-bottom:7pt; } |
| h2 { font-family:"Arial"; font-size:16pt; margin-top:3pt; margin-bottom:5pt; } |
| h3 { font-size:13pt; margin-top:2pt; margin-bottom:3pt; } |
| h4 { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } |
| dl { margin-top:1pt; margin-bottom:1pt; } |
| dl.member { margin-top:1pt; margin-bottom:1pt; background-color:#eeeeff; } |
| dt { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } |
| dt.member { font-size:13pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } |
| dt.simple { font-size:10pt; font-weight:normal; margin-top:2pt; margin-bottom:1pt; } |
| dd { font-size:10pt; margin-top:1pt; margin-bottom:1pt; } |
| dd.member { font-size:10pt; margin-top:1pt; margin-bottom:1pt; background-color:#ffffff; } |
| p { font-size:10pt; margin-top:3pt; margin-bottom:1pt; } |
| pre { font-family: Times, serif; font-size:10pt; margin-top:1pt; margin-bottom:1pt; } |
| tr { font-size:10pt; } |
| td { font-size:10pt; } |
| </style> |
| |
| <meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8"> |
| </head> |
| <body bgcolor="#ffffff"> |
| <a name="_top_"> </a> |
| <table border="0" cellpadding="1" cellspacing="0"> |
| <tr align="center" valign="top"> |
| <td bgcolor="#eeeeff"> <a href="../index.html" alt><font family="Arial" color="#000000" size="+1"><b>Overview</b></font></a> </td> |
| <td bgcolor="#eeeeff"> <a href="index.html" alt><font family="Arial" color="#000000" size="+1"><b>Namespace</b></font></a> </td> |
| <td bgcolor="#eeeeff"> <font family="Arial" color="#000000" size="+1">Class</font> </td> |
| <td bgcolor="#eeeeff"> <a href="../index-files/index-1.html" alt><font family="Arial" color="#000000" size="+1"><b>Index</b></font></a> </td> |
| <td bgcolor="#eeeeff"> <a href="../help.html" alt><font family="Arial" color="#000000" size="+1"><b>Help</b></font></a> </td> |
| </tr> |
| </table> |
| <table cellpadding="0" cellspacing="3"></table> |
| <hr> |
| <div align="center" style="background-color:#ccccff; line-height:26pt;"><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-203"> </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> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Abbreviates a system notation path |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">ustrSystemPath[in]</td> |
| <td><pre><pre>the full system path to abbreviate |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pustrCompacted[out]</td> |
| <td><pre><pre>receives the compacted system path on output |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pfnCalcWidth[in]</td> |
| <td><pre><pre>function ptr that calculates the width of a string. Can be zero. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uMaxWidth[in]</td> |
| <td><pre><pre>maximum width allowed that is retunrned from pfnCalcWidth. |
| If pfnCalcWidth is zero the character count is assumed as width. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one osl_File_E_INVAL |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>oslCalcTextWidthFunc <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_acquireDirectoryItem-187"> </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> |
| <tr> |
| <td><a href="t-oslDirectoryItem.html">oslDirectoryItem</a> </td> |
| <td> Item );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Increases the refcount of a directory item handle |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Item</td> |
| <td><pre><pre>a handle received by a call to <code>osl_getDirectoryItem</code>, <code>osl_getNextDirectoryItem</code>. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_NOMEM not enough memory for allocating structures <br> |
| osl_File_E_INVAL the format of the parameters was not valid<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getDirectoryItem <br> |
| osl_getNextDirectoryItem <br> |
| osl_releaseDirectoryItem <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_acquireVolumeDeviceHandle-189"> </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> |
| <tr> |
| <td><a href="t-oslVolumeDeviceHandle.html">oslVolumeDeviceHandle</a> </td> |
| <td> Handle );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"/></dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_automountVolumeDevice-189"> </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> |
| <tr> |
| <td><a href="t-oslVolumeDeviceHandle.html">oslVolumeDeviceHandle</a> </td> |
| <td> Handle );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"/></dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_closeDirectory-185"> </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> |
| <tr> |
| <td><a href="t-oslDirectory.html">oslDirectory</a> </td> |
| <td> Directory );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Releases a directory handle |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Directory</td> |
| <td><pre><pre>a handle received by a call to <code>osl_openDirectory</code>. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_INVAL the format of the parameters was not valid<br> |
| osl_File_E_NOMEM not enough memory for allocating structures <p> |
| |
| These errorcodes can (eventually) be returned:<p> |
| osl_File_E_BADF Invalid oslDirectory parameter<br> |
| osl_File_E_INTR function call was interrupted<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_openDirectory <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_closeFile-200"> </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> |
| <tr> |
| <td><a href="t-oslFileHandle.html">oslFileHandle</a> </td> |
| <td> Handle );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Closes an open file. |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Handle</td> |
| <td><pre><pre>Handle to a file previously open by a call to <code>osl_openFile</code>. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_INVAL the format of the parameters was not valid<p> |
| |
| These errorcodes can (eventually) be returned:<p> |
| 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 I/O error<p> |
| </pre></dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_copyFile-126"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strPath,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> *</td> |
| <td>strDestPath );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Copies a file to a new destination. Copies only files not directories. No assumptions should |
| be made about preserving attributes or file time. |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strPath</td> |
| <td><pre><pre>Full qualified UNC path of the source file. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strDestPath</td> |
| <td><pre><pre>Full qualified UNC path of the destination file. A directory is |
| NOT a valid destination file ! |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_moveFile <br> |
| osl_removeFile <br> |
| osl_createDirectory <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_createDirectory-123"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strPath );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Creates a directory. |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strPatg</td> |
| <td><pre><pre>Full qualified UNC path of the directory to create. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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<p> |
| |
| These errorcodes can (eventually) be returned:<p> |
| osl_File_E_LOOP Too many symbolic links encountered<br> |
| osl_File_E_FAULT Bad address<br> |
| osl_FileE_IO I/O error<br> |
| osl_File_E_MLINK Too many links<br> |
| osl_File_E_MULTIHOP Multihop attempted<br> |
| osl_File_E_NOLINK Link has been severed<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_removeDirectory <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_getAbsoluteFileURL-202"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strDirBase,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> *</td> |
| <td>strRelative,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * *</td> |
| <td>strAbsolute );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Converts a path relative to a given directory into an full qualified UNC path. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strDirBase</td> |
| <td><pre><pre>Base directory to which the relative path is related to. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strRelative[in]</td> |
| <td><pre><pre>Path of a file or directory relative to the directory path |
| specified by <code>strDirBase</code>. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strAbsolute</td> |
| <td><pre><pre>On success it receives the full qualified UNC path of the |
| requested relative path. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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<p> |
| |
| |
| These errorcodes can (eventually) be returned:<p> |
| osl_File_E_OVERFLOW Value too large for defined data type<p> |
| 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<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getFileStatus <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_getCanonicalName-201"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strRequested,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * *</td> |
| <td>strValid );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Description</dt> |
| <dd><pre>Determines a valid unused canonical name for a requested name. Depending on file system and operation 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 file system and |
| operating system. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strRequested</td> |
| <td><pre><pre>Requested name of a file or directory. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strValid</td> |
| <td><pre><pre>On success receives a name which is unused and valid on the actual operating system and |
| file system. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_INVAL the format of the parameters was not valid<br> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getFileStatus <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_getDirectoryItem-186"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strFilePath,</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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Retrieves a single directory item handle with an initial refcount of 1. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strFilePath</td> |
| <td><pre><pre>absolute file path following the notation explained in the documentation for |
| <code>osl_openDirectory</code>. Due to performance issues it is not recommended to use this function |
| while enumerating the contents of a directory. In this case use <code>osl_getNextDirectoryItem</code> instead. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pItem</td> |
| <td><pre><pre>on success it receives a handle which can be used for subsequent calls to <code>osl_getFileStatus</code>. |
| The handle has to be released by a call to <code>osl_releaseDirectoryItem</code>. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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 File name too long<br> |
| osl_File_E_NOTDIR A component of the path prefix of path is not a directory<p> |
| |
| These errorcodes can (eventually) be returned:<p> |
| osl_File_E_IO I/O error<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 function call was interrupted<p> |
| |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_releaseDirectoryItem <br> |
| osl_acquireDirectoryItem <br> |
| osl_getFileStatus <br> |
| osl_getNextDirectoryItem <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_getFilePos-194"> </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> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Retrieves the current position of the internal pointer of an open file. |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Handle</td> |
| <td><pre><pre>Handle to an open file. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pPos</td> |
| <td><pre><pre>On Success it receives the current position of the file pointer. |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_openFile <br> |
| osl_setFilePos <br> |
| osl_readFile <br> |
| osl_writeFile <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_getFileStatus-188"> </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> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Retrieves information about a single file or directory |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Item</td> |
| <td><pre><pre>a handle received by a previous call to <code>osl_getDirectoryItem</code>, |
| <code>osl_getNextDirectoryItem</code>. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pStatus</td> |
| <td><pre><pre>points to a structure which receives the information of the file or directory |
| represented by the handle <code>Item</code>. The member <code>uStructSize</code> has to be initialized to |
| <code>sizeof(oslFileStatus)</code> before calling this function. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uFieldMask</td> |
| <td><pre><pre>specifies which fields of the structure pointed to by <code>pStatus</code> |
| are of interest to the caller. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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<p> |
| |
| These errorcodes can (eventually) be returned:<p> |
| 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 I/O error<br> |
| osl_File_E_NOSYS Function not implemented<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getDirectoryItem <br> |
| osl_getNextDirectoryItem <br> |
| <a href="t-oslFileStatus.html">oslFileStatus</a> <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_getFileURLFromSystemPath-201"> </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> |
| <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>pustrFileURL );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Converts a system dependend path into a FileURL |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">dir[in]</td> |
| <td><pre><pre>System dependent path of a file or directory |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strPath[out]</td> |
| <td><pre><pre>On success it receives the file URL |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_INVAL the format of the parameters was not valid<br> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getSystemPathFromFileURL <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_getNextDirectoryItem-184"> </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> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Retrieves the next item(s) of a previously openend directory. All handles have an initial |
| refcount of 1. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Directory</td> |
| <td><pre><pre>is the directory handle received from a previous call to <code>osl_openDirectory</code>. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pItem</td> |
| <td><pre><pre>On success it receives a handle that can be used for subsequent calls to <code>osl_getFileStatus</code>. |
| The handle has to be released by a call to <code>osl_releaseDirectoryItem</code>. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uHint</td> |
| <td><pre><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></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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<p> |
| |
| These errorcodes can (eventually) be returned:<p> |
| osl_File_E_BADF oslDirectory parameter is not valid<br> |
| osl_File_E_OVERFLOW Value too large for defined data type<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_releaseDirectoryItem <br> |
| osl_acquireDirectoryItem <br> |
| osl_getDirectoryItem <br> |
| osl_getFileStatus <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_getSystemPathFromFileURL-201"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> ustrFileURL,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * *</td> |
| <td>pustrSystemPath );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Converts a file URL in a system dependend path |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">dir[in]</td> |
| <td><pre><pre>File URL |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strPath[out]</td> |
| <td><pre><pre>On success it receives the system dependent path of a file or a directory |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_INVAL the format of the parameters was not valid<br> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getFileURLFromSystemPath <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_getVolumeDeviceMountPath-190"> </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> |
| <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>pstrPath );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Gets the normalized absolute file system path where a device is mounted to. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Handle</td> |
| <td><pre><pre>Device handle of the volume retrieved with <code>osl_getVolumeInformation</code>. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pstrPath</td> |
| <td><pre><pre>Receives the path where the device is mounted to. |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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> |
| |
| These errorcodes can (eventually) be returned:<p> |
| osl_File_E_FAULT Bad address<br> |
| osl_FilE_E_INTR function call was interrupted<br> |
| osl_File_E_IO I/O error<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<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getVolumeInformation <br> |
| osl_automountVolumeDevice <br> |
| osl_unmountVolumeDevice <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_getVolumeInformation-191"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strDirectory,</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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Description</dt> |
| <dd><pre>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 <code>osl_getFileStatus</code> should be called to determine if the type is |
| <code>osl_file_Type_Volume</code>. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strDirectory</td> |
| <td><pre><pre>Full qualified UNC path to the volume |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pInfo</td> |
| <td><pre><pre>On success it receives information about the volume. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uFieldMask</td> |
| <td><pre><pre>Specifies which members of the structure should be filled |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_NOMEM not enough memory for allocating structures <br> |
| osl_File_E_INVAL the format of the parameters was not valid<p> |
| |
| These errorcodes can (eventually) be returned:<p> |
| 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 I/O error<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<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getFileStatus <br> |
| <a href="t-oslVolumeInfo.html">oslVolumeInfo</a> <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_isEndOfFile-197"> </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> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Tests if the end of a file is reached. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Handle</td> |
| <td><pre><pre>Handle to an open file. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pIsEOF</td> |
| <td><pre><pre>Points to a variable that receives the end of file |
| status. |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_INVAL the format of the parameters was not valid<br> |
| |
| These errorcodes can (eventually) be returned:<p> |
| osl_File_E_INTR function call was interrupted<br> |
| osl_File_E_IO I/O error<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> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_openFile <br> |
| osl_readFile <br> |
| osl_readLine <br> |
| osl_setFilePos <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_moveFile-126"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strPath,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> *</td> |
| <td>strDestPath );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Moves a file or directory to a new destination or renames it. File time and attributes |
| are preserved. |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strPath</td> |
| <td><pre><pre>Full qualified UNC path of the source file. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strDestPath</td> |
| <td><pre><pre>Full qualified UNC path of the destination file. An existing directory |
| is NOT a valid destination ! |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_copyFile <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_openDirectory-183"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strDirectoryPath,</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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Opens a directory for enumerating its contents. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strDirenctoryPath</td> |
| <td><pre><pre>Denotes the full qualified path of the directory follwing the UNC |
| notation. The path devider is '/'. Relative path specifications are not allowed. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pDirectory</td> |
| <td><pre><pre>on success it receives a handle used for subsequent calls by <code>osl_getNextDirectoryItem</code> |
| on error it receives NULL. The handle has to be released by a call to <code>osl_closeDirectory</code>. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getNextDirectoryItem <br> |
| osl_closeDirectory <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_openFile-192"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strPath,</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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Opens a file. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strPath</td> |
| <td><pre><pre>Full qualified path to the file to open. Only regular files |
| can be openend. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pHandle</td> |
| <td><pre><pre>On success it receives a handle to the open file. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uFlags</td> |
| <td><pre><pre>Specifies the open mode. |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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<p> |
| osl_File_E_AGAIN A write lock could not be established<p> |
| |
| These errorcodes can (eventually) be returned:<p> |
| 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 I/O error<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<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_closeFile <br> |
| osl_setFilePos <br> |
| osl_getFilePos <br> |
| osl_readFile <br> |
| osl_writeFile <br> |
| osl_setFileSize <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_readFile-196"> </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> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Reads a number of bytes from a file. The internal file pointer is increased by the number of bytes |
| read. |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Handle</td> |
| <td><pre><pre>Handle to an open file. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pBuffer</td> |
| <td><pre><pre>Points to a buffer which receives data. The buffer must be large enough |
| to hold <code>uBytesRequested</code> bytes. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uBytesRequested</td> |
| <td><pre><pre>Number of bytes which should be retrieved. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pBytesRead</td> |
| <td><pre><pre>On success the number of bytes which have actually been retrieved. |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_INVAL the format of the parameters was not valid<br> |
| |
| These errorcodes can (eventually) be returned:<p> |
| osl_File_E_INTR function call was interrupted<br> |
| osl_File_E_IO I/O error<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> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_openFile <br> |
| osl_writeFile <br> |
| osl_readLine <br> |
| osl_setFilePos <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_readLine-199"> </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> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Reads a line from given file. The new line delemeter(s) are NOT returned! |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Handle</td> |
| <td><pre><pre>Handle to an open file. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">ppSequence</td> |
| <td><pre><pre>a pointer to a valid sequence. Will hold the line read on return. |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_INVAL the format of the parameters was not valid<br> |
| |
| These errorcodes can (eventually) be returned:<p> |
| osl_File_E_INTR function call was interrupted<br> |
| osl_File_E_IO I/O error<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> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_openFile <br> |
| osl_readFile <br> |
| osl_writeFile <br> |
| osl_setFilePos <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_releaseDirectoryItem-187"> </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> |
| <tr> |
| <td><a href="t-oslDirectoryItem.html">oslDirectoryItem</a> </td> |
| <td> Item );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Decreases the refcount of a directory item handle and releases the data if the |
| refcount reaches 0. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Item</td> |
| <td><pre><pre>a handle received by a call to <code>osl_getDirectoryItem</code>, <code>osl_getNextDirectoryItem</code>. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_NOMEM not enough memory for allocating structures <br> |
| osl_File_E_INVAL the format of the parameters was not valid<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getDirectoryItem <br> |
| osl_getNextDirectoryItem <br> |
| osl_acquireDirectoryItem <br> |
| osl_acquireDirectoryItem <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_releaseVolumeDeviceHandle-189"> </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> |
| <tr> |
| <td><a href="t-oslVolumeDeviceHandle.html">oslVolumeDeviceHandle</a> </td> |
| <td> Handle );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"/></dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_removeDirectory-123"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strPath );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Removes an empty directory. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strPath</td> |
| <td><pre><pre>Full qualified UNC path of the directory. |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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<p> |
| |
| These errorcodes can (eventually) be returned:<p> |
| 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 I/O error<br> |
| osl_File_E_MULTIHOP Multihop attempted<br> |
| osl_File_E_NOLINK Link has been severed<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_createDirectory <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_removeFile-123"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> strPath );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Removes (erases) a regular file. |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strPath</td> |
| <td><pre><pre>Full qualified UNC path of the directory. |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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> |
| |
| These errorcodes can (eventually) be returned:<p> |
| osl_File_E_FAULT Bad address<br> |
| osl_File_E_LOOP Too many symbolic links encountered<br> |
| osl_File_E_IO I/O error<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<p> |
| </pre></dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_searchFileURL-202"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> ustrFileName,</td> |
| </tr> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> *</td> |
| <td>ustrSearchPath,</td> |
| </tr> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Searches a full qualified UNC-Path/File |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">filePath[in]</td> |
| <td><pre><pre>System dependent path / Normalized Path / File-URL or file or relative directory |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">searchPath[in]</td> |
| <td><pre><pre>Paths, in which a given file has to be searched. These paths are only for the search of a |
| file or a relative path, otherwise it will be ignored. If it is set to 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 |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">strPath[out]</td> |
| <td><pre><pre>On success it receives the full qualified UNC path |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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> |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_normalizePath <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_setFileAttributes-204"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> filePath,</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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Sets file-attributes |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">filePath[in]</td> |
| <td><pre><pre>Path of the file |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uAttributes[in]</td> |
| <td><pre><pre>Attributes of the file to be set |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| osl_File_E_INVAL the format of the parameters was not valid<br> |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getFileStatus <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_setFilePos-193"> </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> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Sets the internal position pointer of an open file. |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Handle</td> |
| <td><pre><pre>Handle of an open file received by a previous call to <code>osl_openFile</code>. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uHow</td> |
| <td><pre><pre>Distance to move the internal position pointer (from uPos). |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uPos</td> |
| <td><pre><pre>Absolute position from the beginning of the file. |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_openFile <br> |
| osl_getFilePos <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_setFileSize-195"> </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> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>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. |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Handle</td> |
| <td><pre><pre>Handle to an open file. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uSize</td> |
| <td><pre><pre>New size in bytes. |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_openFile <br> |
| osl_setFilePos <br> |
| osl_getFileStatus <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_setFileTime-205"> </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> |
| <tr> |
| <td><a href="t-rtl_uString.html">rtl_uString</a> * </td> |
| <td> filePath,</td> |
| </tr> |
| <tr> |
| <td><a href="t-TimeValue.html">TimeValue</a> *</td> |
| <td>aCreationTime,</td> |
| </tr> |
| <tr> |
| <td><a href="t-TimeValue.html">TimeValue</a> *</td> |
| <td>aLastAccessTime,</td> |
| </tr> |
| <tr> |
| <td><a href="t-TimeValue.html">TimeValue</a> *</td> |
| <td>aLastWriteTime );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Sets file-Time |
| |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">filePath[in]</td> |
| <td><pre><pre>Path of the file |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">aCreationTime[in]</td> |
| <td><pre><pre>creation time of the given file |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">aLastAccessTime[in]</td> |
| <td><pre><pre>time of the last access of the given file |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">aLastWriteTime[in]</td> |
| <td><pre><pre>time of the last modifying of the given file |
| |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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> |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_getFileStatus <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_unmountVolumeDevice-189"> </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> |
| <tr> |
| <td><a href="t-oslVolumeDeviceHandle.html">oslVolumeDeviceHandle</a> </td> |
| <td> Handle );</td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| <br> |
| </dd> |
| <dd class="member"><table border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"/></dl> |
| <hr> |
| <dl class="member"> |
| <dt class="member"><a name="osl_writeFile-198"> </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> |
| <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 border cellspacing="0"> |
| <tr> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">const</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">volatile</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">static</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">inline</td> |
| <td bgcolor="#eeeeff" width="12%" style="font-family:Arial; font-size:8pt; font-weight:bold;">C-linkage</td> |
| </tr> |
| <tr> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt;">NO</td> |
| <td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td> |
| </tr> |
| </table> |
| <br> |
| </dd> |
| <dd class="member"><dl> |
| <dt>Summary</dt> |
| <dd><pre>Writes a number of bytes to a file. The internal file pointer is increased by the number of bytes |
| read. |
| </pre></dd> |
| <dt>Parameters</dt> |
| <dd><table border="0" width="100%" cellpadding="3" cellspacing="0"> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">Handle</td> |
| <td><pre><pre>Handle to an open file. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pBuffer</td> |
| <td><pre><pre>Points to a buffer which contains the data. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">uBytesToWrite</td> |
| <td><pre><pre>Number of bytes which should be written. |
| </pre></pre></td> |
| </tr> |
| <tr> |
| <td width="15%" style="vertical-align:top; font-weight:bold">pBytesWritten</td> |
| <td><pre><pre>On success the number of bytes which have actually been written. |
| |
| </pre></pre></td> |
| </tr> |
| </table> |
| </dd> |
| <dt>Return</dt> |
| <dd><pre>osl_File_E_None on success otherwise one of the following errorcodes:<p> |
| 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> |
| |
| These errorcodes can (eventually) be returned:<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 I/O error<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<p> |
| |
| </pre></dd> |
| <dt>See Also</dt> |
| <dd>osl_openFile <br> |
| osl_readFile <br> |
| osl_setFilePos <br> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <hr> |
| <a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.</p> |
| </body> |