RFs::TNameValidParam Class Reference

#include <f32file.h>

Link against: EAACPlusAudioControllerUtility.lib

class RFs::TNameValidParam

Public Member Enumerations
enum	TError { ErrNone, ErrBadCharacter, ErrBadName, ErrNameTooLong }

Public Member Functions
	TNameValidParam(TBool)
TError	ErrorCode()
TUint	InvalidCharPos()
void	UseSessionPath(TBool)

Detailed Description

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

Member Enumeration Documentation

Enum TError

possible error codes

Enumerator	Value	Description
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.

Constructor & Destructor Documentation

TNameValidParam ( TBool )

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

ErrorCode

(

)

const [inline]

returns the error code.

InvalidCharPos ( )

TUint

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.

UseSessionPath ( TBool )

void

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.