Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Methods of Class DirectoryItem


DirectoryItem
DirectoryItem();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Constructor.

DirectoryItem
DirectoryItem(
const DirectoryItem & rItem );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Copy constructor.

~DirectoryItem
~DirectoryItem();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Destructor.

operator=
DirectoryItem & operator=(
const DirectoryItem & rItem );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Assignment operator.

is
sal_Bool is();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Check for validity of this instance.
Return
sal_True if object is valid directory item else sal_False.

getFileStatus
RC getFileStatus(
FileStatus & rStatus );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Retrieve information about a single file or directory.
Parameters
rStatus
Reference to a class which receives the information of the file or directory
represented by this directory item. 
        
Return
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
See Also
get()
Directory::getNextItem()
FileStatus

get
static RC get(
const ::rtl::OUString & ustrFileURL,
DirectoryItem & rItem );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO YES YES NO

Summary
Retrieve a single directory item.
Description
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.
Parameters
ustrFileURL
        An absolute file URL. 
        
        
rItem
        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().
        
        
Return
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
See Also
FileStatus
Directory::getNextItem()

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.