UDK 3.2.7 C/C++ API Reference
Public Types | Public Member Functions | Friends
osl::FileStatus Class Reference

The FileStatus class. More...

#include <file.hxx>

List of all members.

Public Types

enum  Type {
  Directory = osl_File_Type_Directory, Volume = osl_File_Type_Volume, Regular = osl_File_Type_Regular, Fifo = osl_File_Type_Fifo,
  Socket = osl_File_Type_Socket, Link = osl_File_Type_Link, Special = osl_File_Type_Special, Unknown = osl_File_Type_Unknown
}

Public Member Functions

 FileStatus (sal_uInt32 nMask)
 Constructor.
 ~FileStatus ()
 Destructor.
sal_Bool isValid (sal_uInt32 nMask) const
 Check if specified fields are valid.
Type getFileType () const
 Get the file type.
sal_Bool isDirectory () const
 Is it a directory? This method returns True for both directories, and volumes.
sal_Bool isRegular () const
 Is it a regular file?
sal_Bool isLink () const
 Is it a link?
sal_uInt64 getAttributes () const
 Get the file attributes.
TimeValue getCreationTime () const
 Get the creation time of this file.
TimeValue getAccessTime () const
 Get the file access time.
TimeValue getModifyTime () const
 Get the file modification time.
sal_uInt64 getFileSize () const
 Get the size of the file.
inline::rtl::OUString getFileName () const
 Get the file name.
inline::rtl::OUString getFileURL () const
 Get the URL of the file.
inline::rtl::OUString getLinkTargetURL () const
 Get the link target URL.

Friends

class DirectoryItem

Detailed Description

The FileStatus class.

See also:
DirectoryItem::getFileStatus

Member Enumeration Documentation

Enumerator:
Directory 
Volume 
Regular 
Fifo 
Socket 
Link 
Special 
Unknown 

Constructor & Destructor Documentation

osl::FileStatus::FileStatus ( sal_uInt32  nMask) [inline]

Constructor.

Parameters:
nMaskSet of flags decribing the demanded information.
osl::FileStatus::~FileStatus ( ) [inline]

Destructor.


Member Function Documentation

TimeValue osl::FileStatus::getAccessTime ( ) const [inline]

Get the file access time.

Returns:
The last access time if this information is valid, an uninitialized TimeValue otherwise.
sal_uInt64 osl::FileStatus::getAttributes ( ) const [inline]

Get the file attributes.

Returns:
The set of attribute flags of this file.
TimeValue osl::FileStatus::getCreationTime ( ) const [inline]

Get the creation time of this file.

Returns:
The creation time if this information is valid, an uninitialized TimeValue otherwise.
inline ::rtl::OUString osl::FileStatus::getFileName ( ) const [inline]

Get the file name.

Returns:
The file name if this information is valid, an empty string otherwise.
sal_uInt64 osl::FileStatus::getFileSize ( ) const [inline]

Get the size of the file.

Returns:
The actual file size if this information is valid, 0 otherwise.
Type osl::FileStatus::getFileType ( ) const [inline]

Get the file type.

Returns:
The file type.
inline ::rtl::OUString osl::FileStatus::getFileURL ( ) const [inline]

Get the URL of the file.

Returns:
The full qualified URL of the file if this information is valid, an empty string otherwise.
inline ::rtl::OUString osl::FileStatus::getLinkTargetURL ( ) const [inline]

Get the link target URL.

Returns:
The link target URL if this information is valid, an empty string otherwise.
TimeValue osl::FileStatus::getModifyTime ( ) const [inline]

Get the file modification time.

Returns:
The last modified time if this information is valid, an uninitialized TimeValue otherwise.
sal_Bool osl::FileStatus::isDirectory ( ) const [inline]

Is it a directory? This method returns True for both directories, and volumes.

Returns:
True if it's a directory, False otherwise.
See also:
getFileType
Since:
LibreOffice 3.6
sal_Bool osl::FileStatus::isLink ( ) const [inline]

Is it a link?

Returns:
True if it's a link, False otherwise.
See also:
getFileType
Since:
LibreOffice 3.6
sal_Bool osl::FileStatus::isRegular ( ) const [inline]

Is it a regular file?

Returns:
True if it's a regular file, False otherwise.
See also:
getFileType
isFile
isLink
Since:
LibreOffice 3.6
sal_Bool osl::FileStatus::isValid ( sal_uInt32  nMask) const [inline]

Check if specified fields are valid.

Parameters:
nMaskSet of flags for the fields to check.
Returns:
sal_True if all fields are valid else sal_False.

Friends And Related Function Documentation

friend class DirectoryItem [friend]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines