TEntry Class Reference

Encapsulates an entry in a directory, which can be another (nested) directory, a file or a volume label. More...

#include <f32file.h>

Public Member Functions
IMPORT_C	TEntry ()
	Default constructor.
IMPORT_C	TEntry (const TEntry &aEntry)
	Copy constructor.
IMPORT_C TEntry &	operator= (const TEntry &aEntry)
	Assignment operator.
IMPORT_C TBool	IsReadOnly () const
	Tests whether the file or directory is read-only.
IMPORT_C TBool	IsHidden () const
	Tests whether the file or directory is hidden.
IMPORT_C TBool	IsSystem () const
	Tests whether the file or directory has the system attribute set.
IMPORT_C TBool	IsDir () const
	Tests whether the entry is a directory.
IMPORT_C TBool	IsArchive () const
	Tests whether the file is an archive file.
const TUid &	operator[] (TInt anIndex) const
	Gets any one of the file's three UIDs.
TBool	IsUidPresent (TUid aUid) const
	Tests whether the specified UID matches any of the UIDs in the UID type.
TBool	IsTypeValid () const
	Test whether the file has a valid UID.
TUid	MostDerivedUid () const
	Gets the most derived (i.e.
IMPORT_C TInt64	FileSize () const
void	SetFileSize (TInt64 aFileSize)
	Sets 64 bit file size.

Public Attributes
TUint	iAtt
	The individual bits within this byte indicate which attributes have been set.
TInt	iSize
	The size of the file in bytes.
TTime	iModified
	The local time of last modification.
TUidType	iType
	The file's UIDtype.
TBufC< KMaxFileName >	iName
	The name of the file relative to the owning directory, with a maximum of KMaxFileName characters.

Detailed Description

Encapsulates an entry in a directory, which can be another (nested) directory, a file or a volume label.

Each directory entry has a name which is relative to its owning directory and a type, which is indicated by its unique identifier (UID).

An entry can be interrogated for the following properties:

1. the kind of entry: stored in the entry UIDs, stored in iType
2. the entry attributes, stored in iAtt
3. the size of entry
4. the time the entry was last modified.

See also

RDir

RFs::Entry

RFs::SetEntry

CfileBase::CurrentEntry

API status

Published to all clients. Released API.

Definition at line 1461 of file f32file.h.

Constructor & Destructor Documentation

TEntry() [1/2]

IMPORT_C TEntry::TEntry

(

)

Default constructor.

(generated from Symbian Developer Library)

TEntry() [2/2]

IMPORT_C TEntry::TEntry

(

const TEntry &

aEntry

)

Copy constructor.

Parameters

aEntry

The TEntry object to be copied.

(generated from Symbian Developer Library)

Member Function Documentation

FileSize()

IMPORT_C TInt64 TEntry::FileSize

(

)

const

IsArchive()

IMPORT_C TBool TEntry::IsArchive

(

)

const

Tests whether the file is an archive file.

KEntryAttArchive

(generated from Symbian Developer Library)

IsDir()

IMPORT_C TBool TEntry::IsDir

(

)

const

Tests whether the entry is a directory.

KEntryAttDir

(generated from Symbian Developer Library)

IsHidden()

IMPORT_C TBool TEntry::IsHidden

(

)

const

Tests whether the file or directory is hidden.

KEntryAttHidden

(generated from Symbian Developer Library)

IsReadOnly()

IMPORT_C TBool TEntry::IsReadOnly

(

)

const

Tests whether the file or directory is read-only.

KEntryAttReadOnly

(generated from Symbian Developer Library)

IsSystem()

IMPORT_C TBool TEntry::IsSystem

(

)

const

Tests whether the file or directory has the system attribute set.

KEntryAttSystem

(generated from Symbian Developer Library)

IsTypeValid()

TBool TEntry::IsTypeValid ( ) const

inline

Test whether the file has a valid UID.

TUidType::IsValid TUidType

(generated from Symbian Developer Library)

IsUidPresent()

TBool TEntry::IsUidPresent ( TUid  aUid ) const

inline

Tests whether the specified UID matches any of the UIDs in the UID type.

TUidType::IsPresent TUidType

Parameters

aUid	The UID to be checked.

(generated from Symbian Developer Library)

MostDerivedUid()

TUid TEntry::MostDerivedUid ( ) const

inline

Gets the most derived (i.e.

the most specific) UID.

TUidType::MostDerived TUidType

(generated from Symbian Developer Library)

operator=()

IMPORT_C TEntry & TEntry::operator=

(

const TEntry &

aEntry

)

Assignment operator.

Parameters

aEntry

The TEntry object to be copied to this TEntry object.

(generated from Symbian Developer Library)

operator[]()

const TUid & TEntry::operator[] ( TInt  anIndex ) const

inline

Gets any one of the file's three UIDs.

TUidType

Parameters

anIndex

Identifies the UID required. This can be zero, one or two. Specifiying any other value raises a panic.

(generated from Symbian Developer Library)

SetFileSize()

void TEntry::SetFileSize ( TInt64  aFileSize )

inline

Sets 64 bit file size.

The low word is stored in iSize and high word is stored in private data member iSizeHigh. This is intended to be used by File Systsem Plugin implementations, and not recommended to be called by general clients of the File Server.

TEntry::iSize

(generated from Symbian Developer Library)

Member Data Documentation

iAtt

TUint TEntry::iAtt

The individual bits within this byte indicate which attributes have been set.

See also

KEntryAttNormal

KEntryAttReadOnly

KEntryAttHidden

KEntryAttSystem

Definition at line 1520 of file f32file.h.

iModified

TTime TEntry::iModified

The local time of last modification.

Definition at line 1533 of file f32file.h.

iName

TBufC<KMaxFileName> TEntry::iName

The name of the file relative to the owning directory, with a maximum of KMaxFileName characters.

See also

KMaxFileName

Definition at line 1548 of file f32file.h.

iSize

TInt TEntry::iSize

The size of the file in bytes.

For files larger that 2G it must be cast to TUint in order to avoid looking like negative signed.

Definition at line 1527 of file f32file.h.

iType

TUidType TEntry::iType

The file's UIDtype.

Definition at line 1539 of file f32file.h.

---

The documentation for this class was generated from the following files:

• f32file.h
• f32file.h.dox