CCTTokenType Class Reference

#include <ct/ccttokentype.h>

Link against: ctfinder.lib

class CCTTokenType : protected CBase, public MCTTokenType

Inherits from

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.

Return Value
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]

Reimplemented from MCTTokenType::Label()const

Gets the label of the token type.

Return Value
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.

Parameters
aInfoInformation about the token type.
aFsAn open file server session.
Return Value
The new token type object.

NewL ( TUid, RFs )

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

Reimplemented from MCTTokenType::NewL(TUid,RFs)

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.

Parameters
aUIDThe UID of the token type.
aFsAn open file server session.
Return Value
The new token type object.

Release ( )

IMPORT_C voidRelease()[virtual]

Reimplemented from MCTTokenType::Release()

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]

Reimplemented from MCTTokenType::Type()const

Gets the UID of the token type.

Return Value
The UID of the token type.