Parses filenames using less space on the stack than TParse. More...
#include <f32file.h>
Public Member Functions | |
| IMPORT_C | TParsePtr (TDes &aName) |
| Constructor taking a reference to a filename. | |
 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 filename passed to the constructor of this object. | |
| IMPORT_C const TDesC & | NameBufC () const |
| Gets a const reference to the descriptor containing the filename 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 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.
- API status
- Published to all clients. Released API.
Constructor & Destructor Documentation
◆ TParsePtr()
| IMPORT_C TParsePtr::TParsePtr | ( | TDes & | aName | ) |
Constructor taking a reference to a filename.
The specified filename is parsed and if this fails, a panic is raised.
- Parameters
-
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 condition: FSCLIENT 24 if the the specified name fails to parse.
(generated from Symbian Developer Library)
Member Function Documentation
◆ NameBuf()
|
protectedvirtual |
Gets a reference to the descriptor containing the filename passed to the constructor of this object.
(generated from Symbian Developer Library)
Implements TParseBase.
◆ NameBufC()
|
protectedvirtual |
Gets a const reference to the descriptor containing the filename passed to the constructor of this object.
(generated from Symbian Developer Library)
Implements TParseBase.
The documentation for this class was generated from the following files:
