Parses filenames. More...

#include <f32file.h>

Inheritance diagram for TParse:

Public Member Functions
IMPORT_C	TParse ()
	Default constructor.

IMPORT_C TInt	Set (const TDesC &aName, const TDesC aRelated, const TDesC aDefault)
	Parses a file specification, allowing wildcards in the filename and extension.

IMPORT_C TInt	SetNoWild (const TDesC &aName, const TDesC aRelated, const TDesC aDefault)
	Parses a file specification; disallows wildcards in any part of the file name or extension.

Public Member Functions inherited from TParseBase
IMPORT_C	TParseBase ()
	Default constructor.

IMPORT_C TInt	PopDir ()
	Removes the last directory from the path in the fully parsed specification.

IMPORT_C TInt	AddDir (const TDesC &aName)
	Adds a single directory onto the end of the path in the fully parsed specification.

IMPORT_C const TDesC &	FullName () const
	Gets the complete file specification.

IMPORT_C TPtrC	Drive () const
	Gets the drive letter.

IMPORT_C TPtrC	Path () const
	Gets the path.

IMPORT_C TPtrC	DriveAndPath () const
	Gets the drive letter and path.

IMPORT_C TPtrC	Name () const
	Gets the filename.

IMPORT_C TPtrC	Ext () const
	Gets the extension.

IMPORT_C TPtrC	NameAndExt () const
	Gets the filename and extension.

IMPORT_C TBool	DrivePresent () const
	Tests whether a drive is present.

IMPORT_C TBool	PathPresent () const
	Tests whether a path is present.

IMPORT_C TBool	NamePresent () const
	Tests whether a file name is present.

IMPORT_C TBool	ExtPresent () const
	Tests whether an extension is present.

IMPORT_C TBool	NameOrExtPresent () const
	Tests whether a filename or an extension are present.

IMPORT_C TBool	IsRoot () const
	Tests whether the path in the fully parsed specification is the root directory.

IMPORT_C TBool	IsWild () const
	Tests whether the filename or the extension in the fully parsed specification contains one or more wildcard characters.

IMPORT_C TBool	IsKMatchOne () const
	Tests whether the name or the extension contains a question mark wildcard.

IMPORT_C TBool	IsKMatchAny () const
	Tests whether the name or the extension contains asterisk wildcards.

IMPORT_C TBool	IsNameWild () const
	Tests whether the filename in the fully parsed specification contains one or more wildcard characters.

IMPORT_C TBool	IsExtWild () const
	Tests whether the extension in the fully parsed specification contains one or more wildcard characters.

Protected Member Functions
IMPORT_C TDes &	NameBuf ()
	Gets a reference to the descriptor containing the file specification passed to the constructor of this object.

IMPORT_C const TDesC &	NameBufC () const
	Gets a const reference to the descriptor containing the file specification passed to the constructor of this object.

Protected Member Functions inherited from TParseBase
TInt	Set (const TDesC aName, const TDesC aRelated, const TDesC *aDefault, TBool allowWild)

Additional Inherited Members
Protected Attributes inherited from TParseBase
TInt16	iMod

Detailed 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.

API status: Published to all clients. Released API.

Definition at line 1929 of file f32file.h.

Constructor & Destructor Documentation

◆ TParse()

IMPORT_C TParse::TParse ( )

Default constructor.

(generated from Symbian Developer Library)

Member Function Documentation

◆ NameBuf()

IMPORT_C TDes & TParse::NameBuf ( )

protectedvirtual

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

(generated from Symbian Developer Library)

Implements TParseBase.

◆ NameBufC()

IMPORT_C const TDesC & TParse::NameBufC ( ) const

protectedvirtual

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

(generated from Symbian Developer Library)

Implements TParseBase.

◆ Set()

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

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

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

(generated from Symbian Developer Library)

◆ SetNoWild()

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

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().

TParse::Set

Parameters

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

(generated from Symbian Developer Library)

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TParse()

Member Function Documentation

◆ NameBuf()

◆ NameBufC()

◆ Set()

◆ SetNoWild()