Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 9145

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Methods of Class Directory</title>
<link rel="stylesheet" type="text/css" href="../../../cpp.css">
</head>
<body>
<div id="adc-cppref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0">
<tr align="center" valign="top">
<td class="navimain">&nbsp;<a href="../../../index.html">Overview</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../index.html">Namespace</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../c-Directory.html">Class</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../../index-files/index-1.html">Index</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../../help.html">Help</a>&nbsp;</td>
</tr>
</table>
<table class="navisub" cellpadding="0" cellspacing="3"></table>
<hr>
<div class="title"><h2>Methods of Class Directory</h2>
</div><hr>
<dl class="member">
<dt class="member"><a name="Directory-376"> </a>Directory</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>Directory</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../osl/c-Directory.html">Directory</a> &amp; </td>
<td>  );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Copy constructor.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="operator=-377"> </a>operator=</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/c-Directory.html">Directory</a> &amp; <strong>operator=</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../osl/c-Directory.html">Directory</a> &amp; </td>
<td>  );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Assignment operator.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="Directory-378"> </a>Directory</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>Directory</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> strPath );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Constructor.

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

</dd>
<dt>Return</dt>
<dd>
 E_None on success
 E_INVAL the format of the parameters was not valid
 E_NOENT the specified path doesn't exist
 E_NOTDIR the specified path is not an directory 
 E_NOMEM not enough memory for allocating structures 
 E_ACCES permission denied
 E_MFILE too many open files used by the process
 E_NFILE too many open files in the system
 E_NAMETOOLONG File name too long
 E_LOOP Too many symbolic links encountered

 </dd>
<dt>See Also</dt>
<dd><a href="o.html#getNextItem-384">getNextItem()</a> <br>
<a href="o.html#close-382">close()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="isOpen-381"> </a>isOpen</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../t-sal_Bool.html">sal_Bool</a> <strong>isOpen</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Query if directory is open.

</dd>
<dt>Description</dt>
<dd>    Query if directory is open and so item enumeration is valid.

    </dd>
<dt>Return</dt>
<dd>
    sal_True if the directory is open else sal_False.

    </dd>
<dt>See Also</dt>
<dd><a href="o.html#open-380">open()</a> <br>
<a href="o.html#close-382">close()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="close-382"> </a>close</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>close</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Close a directory.

</dd>
<dt>Return</dt>
<dd>
    E_None on success 
    E_INVAL the format of the parameters was not valid
    E_NOMEM not enough memory for allocating structures
    E_BADF invalid oslDirectory parameter
    E_INTR the function call was interrupted

    </dd>
<dt>See Also</dt>
<dd><a href="o.html#open-380">open()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="reset-383"> </a>reset</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>reset</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Resets the directory item enumeration to the beginning.

</dd>
<dt>Return</dt>
<dd>
        E_None on success
        E_INVAL the format of the parameters was not valid
        E_NOENT the specified path doesn't exist
        E_NOTDIR the specified path is not an directory 
        E_NOMEM not enough memory for allocating structures 
        E_ACCES permission denied
        E_MFILE too many open files used by the process
        E_NFILE too many open files in the system
        E_NAMETOOLONG File name too long
        E_LOOP Too many symbolic links encountered
        
        </dd>
<dt>See Also</dt>
<dd><a href="o.html#open-380">open()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getNextItem-384"> </a>getNextItem</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>getNextItem</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../osl/c-DirectoryItem.html">DirectoryItem</a> &amp; </td>
<td> rItem,</td>
</tr>
<tr>
<td><a href="../../t-sal_uInt32.html">sal_uInt32</a></td>
<td>nHint = 0 );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieve the next item of a previously opened directory. 

</dd>
<dt>Description</dt>
<dd>        Retrieves the next item of a previously opened directory.
                   
        </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rItem</td>
<td><pre>
        On success a valid DirectoryItem.
        
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">nHint</td>
<td><pre>
        With this parameter the caller can tell the implementation that (s)he
        is going to call this function uHint times afterwards. This enables the implementation to
        get the information for more than one file and cache it until the next calls.

        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success 
        E_INVAL the format of the parameters was not valid
        E_NOMEM not enough memory for allocating structures 
        E_NOENT no more entries in this directory
        E_BADF invalid oslDirectory parameter
        E_OVERFLOW the value too large for defined data type
                
        </dd>
<dt>See Also</dt>
<dd><a href="../../osl/c-DirectoryItem.html">DirectoryItem</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getVolumeInfo-385"> </a>getVolumeInfo</dt>
<dd class="member"><dl>
<dt class="simple">static <a href="../../osl/FileBase/e-RC.html">RC</a> <strong>getVolumeInfo</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> ustrDirectoryURL,</td>
</tr>
<tr>
<td><a href="../../osl/c-VolumeInfo.html">VolumeInfo</a> &amp;</td>
<td>rInfo );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Retrieve information about a volume. 

</dd>
<dt>Description</dt>
<dd>        Retrieves information about a volume. A volume can either be a mount point, a network
        resource or a drive depending on Operating System and File System. 

        </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrDirectoryURL</td>
<td><pre>
        Full qualified URL of the volume
        
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rInfo</td>
<td><pre>
        On success it receives information about the volume.
                
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success 
        E_NOMEM not enough memory for allocating structures 
        E_INVAL the format of the parameters was not valid
        E_NOTDIR not a directory
        E_NAMETOOLONG file name too long
        E_NOENT no such file or directory
        E_ACCES permission denied
        E_LOOP too many symbolic links encountered
        E_FAULT Bad address
        E_IO on I/O errors
        E_NOSYS function not implemented
        E_MULTIHOP multihop attempted
        E_NOLINK link has been severed
        E_INTR function call was interrupted

        </dd>
<dt>See Also</dt>
<dd><a href="../../osl/c-FileStatus.html">FileStatus</a> <br>
<a href="../../osl/c-VolumeInfo.html">VolumeInfo</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="create-386"> </a>create</dt>
<dd class="member"><dl>
<dt class="simple">static <a href="../../osl/FileBase/e-RC.html">RC</a> <strong>create</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> ustrDirectoryURL );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Create a directory.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrDirectoryURL</td>
<td><pre>
        Full qualified URL of the directory to create.

        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success 
        E_INVAL the format of the parameters was not valid
        E_NOMEM not enough memory for allocating structures 
        E_EXIST file exists
        E_ACCES permission denied
        E_NAMETOOLONG file name too long
        E_NOENT no such file or directory
        E_NOTDIR not a directory
        E_ROFS read-only file system
        E_NOSPC no space left on device
        E_DQUOT quota exceeded
        E_LOOP too many symbolic links encountered
        E_FAULT bad address
        E_IO on I/O errors
        E_MLINK too many links
        E_MULTIHOP multihop attempted
        E_NOLINK link has been severed

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

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrDirectoryURL</td>
<td><pre>
        Full qualified URL of the directory.
        
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        E_None on success 
        E_INVAL the format of the parameters was not valid
        E_NOMEM not enough memory for allocating structures 
        E_PERM operation not permitted
        E_ACCES permission denied
        E_NOENT no such file or directory
        E_NOTDIR not a directory
        E_NOTEMPTY directory not empty
        E_FAULT bad address
        E_NAMETOOLONG file name too long
        E_BUSY device or resource busy
        E_ROFS read-only file system
        E_LOOP too many symbolic links encountered
        E_BUSY device or resource busy
        E_EXIST file exists
        E_IO on I/O errors
        E_MULTIHOP multihop attempted
        E_NOLINK link has been severed

        </dd>
<dt>See Also</dt>
<dd><a href="o.html#create-386">create()</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="createPath-388"> </a>createPath</dt>
<dd class="member"><dl>
<dt class="simple">static <a href="../../osl/FileBase/e-RC.html">RC</a> <strong>createPath</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> aDirectoryUrl,</td>
</tr>
<tr>
<td><a href="../../osl/c-DirectoryCreationObserver.html">DirectoryCreationObserver</a> *</td>
<td>aDirectoryCreationObserver = NULL );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Create a directory path.

</dd>
<dt>Description</dt>
<dd>        The osl_createDirectoryPath function creates a specified directory path. 
        All nonexisting sub directories will be created.
        <p><strong>PLEASE NOTE:</strong> You cannot rely on getting the error code 
        E_EXIST for existing directories. Programming against this error code is 
        in general a strong indication of a wrong usage of osl_createDirectoryPath.</p>
        
        </dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">aDirectoryUrl</td>
<td><pre>        [in] The absolute file URL of the directory path to create.
        A relative file URL will not be accepted.
                
        </pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">aDirectoryCreationObserver</td>
<td><pre>        [in] Pointer to an instance of type DirectoryCreationObserver that will
        be informed about the creation of a directory. The value of this 
        parameter may be NULL, in this case notifications will not be sent. 
                        
        </pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
        <dl>
        <dt>E_None</dt> 
        <dd>On success</dd> 
        <dt>E_INVAL</dt>
        <dd>The format of the parameters was not valid</dd>
        <dt>E_ACCES</dt>
        <dd>Permission denied</dd>
        <dt>E_EXIST</dt>
        <dd>The final node of the specified directory path already exist</dd>
        <dt>E_NAMETOOLONG</dt>
        <dd>The name of the specified directory path exceeds the maximum allowed length</dd>
        <dt>E_NOTDIR</dt>
        <dd>A component of the specified directory path already exist as file in any part of the directory path</dd>
        <dt>E_ROFS</dt>
        <dd>Read-only file system</dd>
        <dt>E_NOSPC</dt>
        <dd>No space left on device</dd>
        <dt>E_DQUOT</dt>
        <dd>Quota exceeded</dd>
        <dt>E_FAULT</dt>
        <dd>Bad address</dd>
        <dt>E_IO</dt>
        <dd>I/O error</dd>
        <dt>E_LOOP</dt>
        <dd>Too many symbolic links encountered</dd>
        <dt>E_NOLINK</dt>
        <dd>Link has been severed</dd>
        <dt>E_invalidError</dt>
        <dd>An unknown error occurred</dd>
        </dl>
        
        </dd>
<dt>See Also</dt>
<dd><a href="../../osl/c-DirectoryCreationObserver.html">DirectoryCreationObserver</a> <br>
create <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

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

</html>

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