Symbian
Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]

 » Developer Library » API Reference » C++ API reference » File Server Client Side » TEntry

Location: f32file.h
Link against: efsrv.lib

Class TEntry

TEntry

Support

Supported from 5.0

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:

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

See also:

Member functions

IsReadOnly()

TBool IsReadOnly() const;

Description

Tests whether the file or directory is read-only.

Return value

TBool

True if entry is read-only, false if not

IsHidden()

TBool IsHidden() const;

Description

Tests whether the file or directory is hidden.

Return value

TBool

True if entry is hidden, false if not

IsSystem()

TBool IsSystem() const;

Description

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

Return value

TBool

True if entry is a system entry, false if not

IsDir()

TBool IsDir() const;

Description

Tests whether the entry is a directory.

Return value

TBool

True if entry indicates a directory, false if not

IsArchive()

TBool IsArchive() const;

Description

Tests whether the file is an archive file.

Return value

TBool

True if file is archive, false if not

operator[]()

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

Description

Returns any one of the file’s three UIDs.

Parameters

TInt anIndex

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

Return value

TUid&

On return contains the requested UID.

IsUidPresent()

TBool IsUidPresent(TUid aUid) const;

Description

Tests whether a UID is present in any of the three forms.

Parameters

TUid aUid

The UID to check

Return value

TBool

True if the UID specified is present. false if not.

IsTypeValid()

TBool IsTypeValid() const;

Description

Test whether the file has any UID which is not NULL.

Return value

TBool

True if the entry has any UID which is not NULL, false if all three UIDs are NULL.

MostDerivedUid()

TUid MostDerivedUid() const;

Description

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

Return value

TUid

The entry’s most derived UID

[Top]

Member Data

iAtt

TUint iAtt

Description

The individual bits within this byte indicate which attributes have been set. For more information see file or directory attributes and file or directory attributes'>directory entry details.

iModified

TTime iModified

Description

System time of last modification.

iName

TBufC<KMaxFileName> iName

Description

Name of file relative to the owning directory, with a maximum of KMaxFileName (= 256) characters.

iSize

TInt iSize

Description

Size of the file in bytes.

iType

TUidType iType

Description

Extraction and enquiry functions for a file’s UIDs.

©2002 Symbian Ltd.

[Top]