RFs::TNameValidParam Class Reference
class RFs::TNameValidParam |
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.
Parameters
TBool aUseSessionPath = EFalse | |
Member Functions Documentation
ErrorCode()
TError
| ErrorCode | ( | ) | const [inline] |
returns the error code. TError
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.
Member Enumerations Documentation
Enum TError
Enumerators
ErrNone | |
ErrBadCharacter | |
ErrBadName | |
ErrNameTooLong | |
Member Data Documentation
TUint
iInvalidCharPos
TUint
| iInvalidCharPos | [private] |
TBool
iUseSessionPath
TBool
| iUseSessionPath | [private] |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.