CCTTokenType Class Reference

#include <ct/ccttokentype.h>

Link against: ctframework.lib

class CCTTokenType : protected CBase

Inherits from

  • CCTTokenType
    Public Member Functions
    RFs &Fs()
    virtual IMPORT_C const TDesC &Label()
    IMPORT_C CCTTokenType *NewL(const CCTTokenTypeInfo &, RFs)
    IMPORT_C CCTTokenType *NewL(TUid, RFs)
    virtual IMPORT_C voidRelease()
    virtual IMPORT_C TUidType()
    Protected Member Functions
    CCTTokenType()
    virtual ~CCTTokenType()
    IMPORT_C voidConstructL(TUid, const TDesC &, RFs)
    IMPORT_C voidIncReferenceCount()
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed Description

    A token type.

    This abstract class is instantiated using the ECom plug-in architecture for a particular token type. This adds a delayed destruction behaviour to MCTTokenType, which defines the majority of the interface.

    This class uses protected inheritance from CBase so that clients cannot inadvertantly call delete on instances of it - they should call the Release() method instead.

    Since
    v7.0

    Constructor & Destructor Documentation

    CCTTokenType ( )

    IMPORT_CCCTTokenType()[protected]

    ~CCTTokenType ( )

    IMPORT_C~CCTTokenType()[protected, virtual]

    Destructor

    Member Function Documentation

    ConstructL ( TUid, const TDesC &, RFs )

    IMPORT_C voidConstructL(TUidaUID,
    const TDesC &aLabel,
    RFsaFs
    )[protected]

    For 2 phase construction.

    This function must be called by derived NewL() functions if and only if the class is being constructed without using ECom.

    Fs ( )

    RFs &Fs()[inline]

    Gets a file server session

    Gets the file server session.

    Returns: The file server session.

    IncReferenceCount ( )

    IMPORT_C voidIncReferenceCount()[protected]

    Increments the reference count.

    Must be called for every token created from this interface

    Label ( )

    IMPORT_C const TDesC &Label()const [virtual]

    Gets the label of the token type.

    Returns: The label of the token type.

    NewL ( const CCTTokenTypeInfo &, RFs )

    IMPORT_C CCTTokenType *NewL(const CCTTokenTypeInfo &aInfo,
    RFsaFs
    )[static]

    Creates a CCTTokenType given its CCTTokenTypeInfo.

    Static constructor function that uses the ECom plug-in architecture to load the actual implementation.

    ParameterDescription
    aInfoInformation about the token type.
    aFsAn open file server session.

    Returns: The new token type object.

    NewL ( TUid, RFs )

    IMPORT_C CCTTokenType *NewL(TUidaUID,
    RFsaFs
    )[static]

    Creates a CCTTokenType given the UID of the token type.

    Static constructor function that uses the ECom plug-in architecture to load the actual implementation.

    ParameterDescription
    aUIDThe UID of the token type.
    aFsAn open file server session.

    Returns: The new token type object.

    Release ( )

    IMPORT_C voidRelease()[virtual]

    Releases the token type object.

    To be called when you have finished with the object.

    The API does not allow the destructor to be directly called as this object could remain in existence for longer to hold onto the ECom handle on the DLL; for instance it may not be deleted until all tokens and interfaces have also been released.

    Type ( )

    IMPORT_C TUidType()const [virtual]

    Gets the UID of the token type.

    Returns: The UID of the token type.

    © Nokia 2011.