TParse Class Reference

#include <f32file.h>

class TParse : public TParseBase

Inherits from

TParse
- TParseBase

Public Member Functions
	TParse()
IMPORT_C TInt	Set(const TDesC &, const TDesC , const TDesC )
IMPORT_C TInt	SetNoWild(const TDesC &, const TDesC , const TDesC )

Protected Member Functions
virtual IMPORT_C TDes &	NameBuf()
virtual IMPORT_C const TDesC &	NameBufC()

Inherited Attributes
	TParseBase::iMod

Inherited Functions
	TParseBase::AddDir(const TDesC &)
	TParseBase::Drive()const
	TParseBase::DriveAndPath()const
	TParseBase::DrivePresent()const
	TParseBase::Ext()const
	TParseBase::ExtPresent()const
	TParseBase::FullName()const
	TParseBase::IsExtWild()const
	TParseBase::IsKMatchAny()const
	TParseBase::IsKMatchOne()const
	TParseBase::IsNameWild()const
	TParseBase::IsRoot()const
	TParseBase::IsWild()const
	TParseBase::Name()const
	TParseBase::NameAndExt()const
	TParseBase::NameOrExtPresent()const
	TParseBase::NamePresent()const
	TParseBase::Path()const
	TParseBase::PathPresent()const
	TParseBase::PopDir()
	TParseBase::Set(const TDesC ,const TDesC ,const TDesC *,TBool)
	TParseBase::TParseBase()

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.

Constructor & Destructor Documentation

TParse ( )

IMPORT_C

TParse

(

)

Default constructor.

Member Function Documentation

NameBuf ( )

IMPORT_C TDes &

NameBuf

(

)

[protected, virtual]

Reimplemented from TParseBase::NameBuf()

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

Returns: A reference to the descriptor containing the filename.

NameBufC ( )

IMPORT_C const TDesC &

NameBufC

(

)

const [protected, virtual]

Reimplemented from TParseBase::NameBufC()const

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

Returns: A const reference to the descriptor containing the file specification.

Set ( const TDesC &, const TDesC , const TDesC )

IMPORT_C TInt	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.

Parameter	Description
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.

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

SetNoWild ( const TDesC &, const TDesC , const TDesC )

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.

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