| class RFs::TNameValidParam |
This class is used to for returning meaningful error code values to users of RFs::IsValidName(const TDesC& ,TNameValidParam& ) TError
| Public Member Functions | |
|---|---|
| TNameValidParam(TBool) | |
| TError | ErrorCode() |
| TUint | InvalidCharPos() |
| void | UseSessionPath(TBool) |
| Public Member Enumerations | |
|---|---|
| enum | TError { ErrNone, ErrBadCharacter, ErrBadName, ErrNameTooLong } |
| Private Attributes | |
|---|---|
| TError | iError |
| TUint | iInvalidCharPos |
| TBool | iUseSessionPath |
| 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.
| TBool aUseSessionPath = EFalse |
| 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.
| 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.
| TBool aUseSessionPath |