Class TEntry

class TEntry;

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.

Members

Defined in TEntry:
IsArchive(), IsDir(), IsHidden(), IsReadOnly(), IsSystem(), IsTypeValid(), IsUidPresent(), MostDerivedUid(), TEntry(), TEntry(), iAtt, iModified, iName, iSize, iType, operator=(), operator[]()

See also:

• RDir

IMPORT_C TEntry();

Description

Default constructor.

IMPORT_C TEntry(const TEntry &aEntry);

Description

Copy constructor.

Parameters

const TEntry &aEntry The TEntry object to be copied.

IMPORT_C TEntry &operator=(const TEntry &aEntry);

Description

Assignment operator.

Parameters

const TEntry &aEntry The TEntry object to be copied to this TEntry object.

Return value

TEntry & A reference to this TEntry object.

IMPORT_C TBool IsReadOnly() const;

Description

Tests whether the file or directory is read-only.

Return value

TBool ETrue if entry is read-only, EFalse if not.

See also:

• KEntryAttReadOnly

IMPORT_C TBool IsHidden() const;

Description

Tests whether the file or directory is hidden.

Return value

TBool ETrue if entry is hidden, EFalse if not.

See also:

• KEntryAttHidden

IMPORT_C TBool IsSystem() const;

Description

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

Return value

TBool ETrue if entry is a system entry, EFalse if not.

See also:

• KEntryAttSystem

IMPORT_C TBool IsDir() const;

Description

Tests whether the entry is a directory.

Return value

TBool ETrue if entry indicates a directory, EFalse if not.

See also:

• KEntryAttDir

IMPORT_C TBool IsArchive() const;

Description

Tests whether the file is an archive file.

Return value

TBool ETrue if file is archive, EFalse if not.

See also:

• KEntryAttArchive

inline const TUid &operator[](TInt anIndex) const;

Description

Gets any one of the file's three UIDs.

Parameters

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

Return value

const TUid & On return, contains the requested UID.

See also:

• TUidType

inline TBool IsUidPresent(TUid aUid) const;

Description

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

Parameters

TUid aUid The UID to be checked.

Return value

TBool True if the specified UID is present, false otherwise.

See also:

• TUidType

inline TBool IsTypeValid() const;

Description

Test whether the file has a valid UID.

Return value

TBool True if the entry has a valid UID, false otherwise.

See also:

• TUidType

inline TUid MostDerivedUid() const;

Description

Gets the most derived (i.e. the most specific) UID.

Return value

TUid The entry's most derived UID.

See also:

• TUidType

TUint iAtt;

Description

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

See also:

• KEntryAttNormal
• KEntryAttReadOnly
• KEntryAttHidden
• KEntryAttSystem

TInt iSize;

Description

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.

TTime iModified;

Description

The local time of last modification.

TUidType iType;

Description

The file's UIDtype

TBufC< KMaxFileName > iName;

Description

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

See also:

• KMaxFileName