<html>
<head>
<title>Methods of Class DirectoryItem</title>
<link rel="stylesheet" type="text/css" href="../../../cpp.css">
</head>
<body>
<div id="adc-cppref">
<a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0">
<tr align="center" valign="top">
<td class="navimain"> <a href="../../../index.html">Overview</a> </td>
<td class="navimain"> <a href="../index.html">Namespace</a> </td>
<td class="navimain"> <a href="../c-DirectoryItem.html">Class</a> </td>
<td class="navimain"> <a href="../../../index-files/index-1.html">Index</a> </td>
<td class="navimain"> <a href="../../../help.html">Help</a> </td>
</tr>
</table>
<table class="navisub" cellpadding="0" cellspacing="3"></table>
<hr>
<div class="title"><h2>Methods of Class DirectoryItem</h2>
</div><hr>
<dl class="member">
<dt class="member"><a name="DirectoryItem-222"> </a>DirectoryItem</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>DirectoryItem</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>Constructor.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="DirectoryItem-223"> </a>DirectoryItem</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>DirectoryItem</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const <a href="../../osl/c-DirectoryItem.html">DirectoryItem</a> & </td>
<td> rItem );</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>Copy constructor.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="~DirectoryItem-224"> </a>~DirectoryItem</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>~DirectoryItem</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="operator=-225"> </a>operator=</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/c-DirectoryItem.html">DirectoryItem</a> & <strong>operator=</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const <a href="../../osl/c-DirectoryItem.html">DirectoryItem</a> & </td>
<td> rItem );</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>Assignment operator.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="is-226"> </a>is</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../t-sal_Bool.html">sal_Bool</a> <strong>is</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>Check for validity of this instance.
</dd>
<dt>Return</dt>
<dd>
sal_True if object is valid directory item else sal_False.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getFileStatus-228"> </a>getFileStatus</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../osl/FileBase/e-RC.html">RC</a> <strong>getFileStatus</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../osl/c-FileStatus.html">FileStatus</a> & </td>
<td> rStatus );</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 information about a single file or directory.
</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rStatus</td>
<td><pre>
Reference to a class which receives the information of the file or directory
represented by this directory item.
</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_LOOP too many symbolic links encountered
E_ACCES permission denied
E_NOENT no such file or directory
E_NAMETOOLONG file name too long
E_BADF invalid oslDirectoryItem parameter
E_FAULT bad address
E_OVERFLOW value too large for defined data type
E_INTR function call was interrupted
E_NOLINK link has been severed
E_MULTIHOP components of path require hopping to multiple remote machines and the file system does not allow it
E_MFILE too many open files used by the process
E_NFILE too many open files in the system
E_NOSPC no space left on device
E_NXIO no such device or address
E_IO on I/O errors
E_NOSYS function not implemented
</dd>
<dt>See Also</dt>
<dd><a href="o.html#get-227">get()</a> <br>
Directory::getNextItem() <br>
<a href="../../osl/c-FileStatus.html">FileStatus</a> <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="get-227"> </a>get</dt>
<dd class="member"><dl>
<dt class="simple">static <a href="../../osl/FileBase/e-RC.html">RC</a> <strong>get</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> & </td>
<td> ustrFileURL,</td>
</tr>
<tr>
<td><a href="../../osl/c-DirectoryItem.html">DirectoryItem</a> &</td>
<td>rItem );</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 a single directory item.
</dd>
<dt>Description</dt>
<dd> Retrieves a single directory item. The returned handle has an initial refcount of 1.
Due to performance issues it is not recommended to use this function while
enumerating the contents of a directory. In this case use osl_getNextDirectoryItem() instead.
</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ustrFileURL</td>
<td><pre>
An absolute file URL.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rItem</td>
<td><pre>
On success it receives a handle which can be used for subsequent calls to osl_getFileStatus().
The handle has to be released by a call to osl_releaseDirectoryItem().
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>
E_None on success
E_INVAL the format of the parameters was not valid
E_NOMEM not enough memory for allocating structures
E_ACCES permission denied
E_MFILE too many open files used by the process
E_NFILE too many open files in the system
E_NOENT no such file or directory
E_LOOP too many symbolic links encountered
E_NAMETOOLONG the file name is too long
E_NOTDIR a component of the path prefix of path is not a directory
E_IO on I/O errors
E_MULTIHOP multihop attempted
E_NOLINK link has been severed
E_FAULT bad address
E_INTR the function call was interrupted
</dd>
<dt>See Also</dt>
<dd><a href="../../osl/c-FileStatus.html">FileStatus</a> <br>
Directory::getNextItem() <br>
</dd>
</dl>
</dd>
</dl>
<hr>
<a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p>
</div> <!-- id="adc-cppref" -->
</body>
</html>
