Class TParse

class TParse : public TParseBase;

Description

Parses filenames.

The class uses the full filename structure supported by Symbian OS.

TParse works by using the Set() function to set up the filename to be parsed. Then, various getter functions defined in the base class, TParseBase, such as: FullName(), Drive(), Path(), DriveAndPath(), Name(), Ext() and NameAndExt() may be used to retrieve path components.

There are a number of restrictions to valid path components, which are described in guide documentation.

Derivation

• TParseBase - Base class for file name parsing

• TParse - Parses filenames

Members

Defined in TParse:

• NameBuf()Gets a reference to the descriptor containing the file specification passed to the constructor of this object
• NameBufC()Gets a const reference to the descriptor containing the file specification passed to the constructor of this object
• Set()Parses a file specification, allowing wildcards in the filename and extension
• SetNoWild()Parses a file specification; disallows wildcards in any part of the file name or extension
• TParse()Default constructor

Inherited from 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
• 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
• iMod

IMPORT_C TParse();

Description

Default constructor.

IMPORT_C TInt Set(const TDesC &aName, const TDesC *aRelated, const TDesC *aDefault);

Description

Parses a file specification, allowing wildcards in the filename and extension.

This function sets up the TParse object so that it can be used to provide useful information.

Parameters

const TDesC &aName The file specification to be parsed. const TDesC *aRelated The related file specification. This is optional, set to NULL to omit. const TDesC *aDefault The default file specification. This is optional, set to NULL to omit.

Return value

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

IMPORT_C TInt SetNoWild(const TDesC &aName, const TDesC *aRelated, const TDesC *aDefault);

Description

Parses a file specification; disallows wildcards in any part of the file name or extension.

If you need to specify wildcards use Set(). Otherwise, this function behaves in the same way as Set().

Parameters

const TDesC &aName The file specification to be parsed. const TDesC *aRelated The related file specification. This is optional, set to NULL to omit. const TDesC *aDefault The default file specification. This is optional, set to NULL to omit.

Return value

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

protected: virtual IMPORT_C TDes &NameBuf();

Description

Gets a reference to the descriptor containing the file specification passed to the constructor of this object.

Return value

TDes & A reference to the descriptor containing the filename.

protected: virtual IMPORT_C const TDesC &NameBufC() const;

Description

Gets a const reference to the descriptor containing the file specification passed to the constructor of this object.

Return value

const TDesC & A const reference to the descriptor containing the file specification.