Class TParsePtr

class TParsePtr : public TParseBase;

Description

Parses filenames using less space on the stack than TParse.

Stores a reference to a filename, unlike TParse, which uses a 512 byte TFileName object as an internal buffer to store a copy of the filename. The filename's components (drive, path, etc.) can be retrieved using the functions provided by the base class, TParseBase. This class should be used in preference to TParse when minimising stack usage is a priority.

Derivation

• TParseBase - Base class for file name parsing

• TParsePtr - Parses filenames using less space on the stack than TParse

Members

Defined in TParsePtr:

• NameBuf()Gets a reference to the descriptor containing the filename passed to the constructor of this object
• NameBufC()Gets a const reference to the descriptor containing the filename passed to the constructor of this object
• TParsePtr()Constructor taking a reference to a filename

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

See also:

• TParseParses filenames
• TFileNameA buffer that can contain the name of a file

IMPORT_C TParsePtr(TDes &aName);

Description

Constructor taking a reference to a filename.

The specified filename is parsed and if this fails, a panic is raised.

Parameters

TDes &aName Reference to the filename to be parsed. On return contains the fully parsed path specification. If a filename and extension are specified, they may both contain wildcards. The maximum length is KMaxFileName characters.

Panic codes

FSCLIENT 24 if the the specified name fails to parse.

See also:

• KMaxFileNameDefines the maximum length of a filename

protected: virtual IMPORT_C TDes &NameBuf();

Description

Gets a reference to the descriptor containing the filename 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 filename passed to the constructor of this object.

Return value

const TDesC & A const reference to the descriptor containing the filename.