TParseBase in Base F32

class TParseBase;

Description

Base class for file name parsing.

You first need to set up the path to be parsed using either a TParse, TParsePtr or TParsePtrC object.

The interrogation and extraction functions in this class allow you to test whether a component has been specified in the pathname, and if so, to extract it. If a component is not present in the pathname, the extraction function returns an empty string.

This class also allows directories to be added to, and popped from the path.

Notes:

1. the filename modification functions cannot be used by the TParsePtrC class.

2. navigation using .. and . is not supported.

Members

Defined in TParseBase:

AddDir()Adds a single directory onto the end of the path in the fully parsed specification
Drive()Gets the drive letter
DriveAndPath()Gets the drive letter and path
DrivePresent()Tests whether a drive is present
Ext()Gets the extension
ExtPresent()Tests whether an extension is present
FullName()Gets the complete file specification
IsExtWild()Tests whether the extension in the fully parsed specification contains one or more wildcard characters
IsKMatchAny()Tests whether the name or the extension contains asterisk wildcards
IsKMatchOne()Tests whether the name or the extension contains a question mark wildcard
IsNameWild()Tests whether the filename in the fully parsed specification contains one or more wildcard characters
IsRoot()Tests whether the path in the fully parsed specification is the root directory
IsWild()Tests whether the filename or the extension in the fully parsed specification contains one or more wildcard characters
Name()Gets the filename
NameAndExt()Gets the filename and extension
NameBuf()
NameBufC()
NameOrExtPresent()Tests whether a filename or an extension are present
NamePresent()Tests whether a file name is present
Path()Gets the path
PathPresent()Tests whether a path is present
PopDir()Removes the last directory from the path in the fully parsed specification
TParseBase()Default constructor
iMod

Description

Default constructor.

IMPORT_C TInt PopDir();

Description

Removes the last directory from the path in the fully parsed specification.

This function may be used to navigate up one level in a directory hierarchy. An error is returned if the specified directory is the root.

Return value

TInt

KErrNone if successful, otherwise one of the other system-wide error codes.

IMPORT_C TInt AddDir(const TDesC &aName);

Description

Adds a single directory onto the end of the path in the fully parsed specification.

The directory is inserted between the final directory, and the filename, if there is one.

Parameters

const TDesC &aName

The directory to be added. It must not start with a \ otherwise the function does not recognise it as a valid directory name and an error is returned. The directory name must not end with a \ since the function adds this automatically. It must not exceed the maximum filename length, KMaxFileName characters, otherwise an error is returned.

Return value

TInt

KErrNone if successful, otherwise another of the system-wide error codes.

Description

Gets the complete file specification.

This is in the form:

drive-letter: \path\filename.extension

Return value

const TDesC &

The fully parsed file specification.

IMPORT_C TPtrC Drive() const;

Description

Gets the drive letter.

The drive letter is in the form:

drive-letter:

Note that the drive letter is folded.

Return value

TPtrC

The drive letter and colon.

IMPORT_C TPtrC Path() const;

Description

Gets the path.

The path is in the form:

\path\

Return value

TPtrC

The path. It always begins and ends in a backslash.

IMPORT_C TPtrC DriveAndPath() const;

Description

Gets the drive letter and path.

This is in the form

drive-letter:\path\

Note that the drive letter is folded

Return value

TPtrC

The drive and path.

IMPORT_C TPtrC Name() const;

Description

Gets the filename.

This is in the form

filename

Return value

TPtrC

The filename.

IMPORT_C TPtrC Ext() const;

Description

Gets the extension.

This is in the form:

.extension

Return value

TPtrC

The extension and preceding dot.

IMPORT_C TPtrC NameAndExt() const;

Description

Gets the filename and extension.

This is in the form:

filename.ext

Return value

TPtrC

The filename and extension.

IMPORT_C TBool DrivePresent() const;

Description

Tests whether a drive is present.

Note that this function refers to a component in the aName argument specified in calls to TParse::Set(), TParse::SetNoWild() or RFs::Parse(), not to the resulting fully parsed file specification.

Return value

TBool

True if a drive present, false if not.

Description

Tests whether a path is present.

Note that this function refers to a component in the aName argument specified in calls to TParse::Set(), TParse::SetNoWild() or RFs::Parse(), not to the resulting fully parsed file specification.

Return value

TBool

True if a path present, false if not.

Description

Tests whether a file name is present.

Note that this function refers to a component in the aName argument specified in calls to TParse::Set(), TParse::SetNoWild() or RFs::Parse(), not to the resulting fully parsed file specification.

This function returns true even if the filename specified in aName contains only wildcards. It only returns false if nothing is specified.

Return value

TBool

True if a name present, false if not.

IMPORT_C TBool ExtPresent() const;

Description

Tests whether an extension is present.

Note that this function refers to a component in the aName argument specified in calls to TParse::Set(), TParse::SetNoWild() or RFs::Parse(), not to the resulting fully parsed file specification.

This function returns true even if the extension contains only wildcards. It only returns false if nothing is specified.

Return value

TBool

True if an extension present, false if not.

IMPORT_C TBool NameOrExtPresent() const;

Description

Tests whether a filename or an extension are present.

Note that this function refers to a component in the aName argument specified in calls to TParse::Set(), TParse::SetNoWild() or RFs::Parse(), not to the resulting fully parsed file specification.

This function returns true even if the filename or extension specified in aName contain only wildcards. It only returns false if nothing is specified.

Return value

TBool

True if either a name or an extension or both are present, otherwise false.

IMPORT_C TBool IsRoot() const;

Description

Tests whether the path in the fully parsed specification is the root directory.

Return value

TBool

True if path is root, false if not.

IMPORT_C TBool IsWild() const;

Description

Tests whether the filename or the extension in the fully parsed specification contains one or more wildcard characters.

Return value

TBool

True if wildcards are present, false if not.

IMPORT_C TBool IsKMatchOne() const;

Description

Tests whether the name or the extension contains a question mark wildcard.

Return value

TBool

True if either the name or extension has a ? wild card, false otherwise.

IMPORT_C TBool IsKMatchAny() const;

Description

Tests whether the name or the extension contains asterisk wildcards.

Return value

TBool

True if either the name or extension has a * wild card, false otherwise.

IMPORT_C TBool IsNameWild() const;

Description

Tests whether the filename in the fully parsed specification contains one or more wildcard characters.

Return value

TBool

True if the filename contains wildcard characters, false if not.

IMPORT_C TBool IsExtWild() const;

Description

Tests whether the extension in the fully parsed specification contains one or more wildcard characters.

Return value

TBool

True if the extension contains wildcard characters, false if not.

protected: virtual TDes &NameBuf()=0;

Description

Return value

TDes &

protected: virtual const TDesC &NameBufC() const=0;

Description

Return value

const TDesC &

protected: TInt16 iMod;

Class TParseBase

Description

Members

See also:

Construction and destruction

TParseBase()

Description

Member functions

PopDir()

Description

Return value

AddDir()

Description

Parameters

Return value

See also:

FullName()

Description

Return value

Drive()

Description

Return value

Path()

Description

Return value

DriveAndPath()

Description

Return value

Name()

Description

Return value

Ext()

Description

Return value

NameAndExt()

Description

Return value

DrivePresent()

Description

Return value

See also:

PathPresent()

Description

Return value

See also:

NamePresent()

Description

Return value

ExtPresent()

Description

Return value

NameOrExtPresent()

Description

Return value

IsRoot()

Description

Return value

IsWild()

Description

Return value

IsKMatchOne()

Description

Return value

IsKMatchAny()

Description

Return value

IsNameWild()

Description

Return value

IsExtWild()

Description

Return value

NameBuf()

Description

Return value

NameBufC()

Description

Return value

Member data

iMod

Class `TParseBase`

`TParseBase()`

`PopDir()`

`AddDir()`

`FullName()`

`Drive()`

`Path()`

`DriveAndPath()`

`Name()`

`Ext()`

`NameAndExt()`

`DrivePresent()`

`PathPresent()`

`NamePresent()`

`ExtPresent()`

`NameOrExtPresent()`

`IsRoot()`

`IsWild()`

`IsKMatchOne()`

`IsKMatchAny()`

`IsNameWild()`

`IsExtWild()`

`NameBuf()`

`NameBufC()`

`iMod`