RFs::TNameValidParam Class Reference

This class is used to for returning meaningful error code values to users of RFs::IsValidName(const TDesC& ,TNameValidParam& ) More...

#include <f32file.h>

Public Types
enum	TError { ErrNone , ErrBadCharacter , ErrBadName , ErrNameTooLong }
	possible error codes More...

Public Member Functions
	TNameValidParam (TBool aUseSessionPath=EFalse)
	Initialises the members of the class.
TError	ErrorCode () const
	returns the error code.
void	UseSessionPath (TBool aUseSessionPath)
	Allows the user to set, whether he wants to use the session path for filling up missing parts of the name that he passes to RFs::IsValidName(TDesC& aName, TNameValidParam& aParam).
TUint	InvalidCharPos () const
	if the error code returned by TNameValidParam::ErrorCode() is TError::ErrBadCharacter, then this returns the position of the rightmost invalid character.

Friends
class	TFsIsValidName

Detailed Description

This class is used to for returning meaningful error code values to users of RFs::IsValidName(const TDesC& ,TNameValidParam& )

See also

TError

Definition at line 2233 of file f32file.h.

Member Enumeration Documentation

TError

enum RFs::TNameValidParam::TError

possible error codes

Enumerator
ErrNone	no error.
ErrBadCharacter	aName contains a bad character; and its position is in iInvalidCharPos.
ErrBadName	aName isn't a valid file or directory name.
ErrNameTooLong	aName length or aName + session path length (see iUseSessionPath) is longer than 256 characters.

Definition at line 2240 of file f32file.h.

Constructor & Destructor Documentation

TNameValidParam()

RFs::TNameValidParam::TNameValidParam ( TBool  aUseSessionPath = EFalse )

inline

Initialises the members of the class.

By default iUseSessionPath is set to EFalse, however one could set it to ETrue.

Member Function Documentation

ErrorCode()

TError RFs::TNameValidParam::ErrorCode ( ) const

inline

returns the error code.

TError

(generated from Symbian Developer Library)

InvalidCharPos()

TUint RFs::TNameValidParam::InvalidCharPos ( ) const

inline

if the error code returned by TNameValidParam::ErrorCode() is TError::ErrBadCharacter, then this returns the position of the rightmost invalid character.

For eg: "a>bcd>" would have the iInvalidCharPos=6 and not 2. However preference is given to wild characters whil reporting the invalid character position For eg: "a*bcd>" would return the iInvalidCharPos= 2 and not 6. if any other error code is returned then this value is 0.

(generated from Symbian Developer Library)

UseSessionPath()

void RFs::TNameValidParam::UseSessionPath ( TBool  aUseSessionPath )

inline

Allows the user to set, whether he wants to use the session path for filling up missing parts of the name that he passes to RFs::IsValidName(TDesC& aName, TNameValidParam& aParam).

If aUseSessionPath is EFalse, then the sessionpath is not used to validate aName.

(generated from Symbian Developer Library)

Friends And Related Symbol Documentation

TFsIsValidName

friend class TFsIsValidName

friend

Definition at line 2251 of file f32file.h.

---

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

• f32file.h
• f32file.h.dox