#include <ct/mcttokentype.h>
| class MCTTokenType |
| Public Member Functions | |
|---|---|
| pure virtual void | CancelList() |
| pure virtual void | CancelOpenToken() |
| pure virtual const TDesC & | Label() |
| pure virtual void | List(RCPointerArray< HBufC > &, TRequestStatus &) |
| MCTTokenType * | NewL(const CCTTokenTypeInfo &, RFs) |
| MCTTokenType * | NewL(TUid, RFs) |
| pure virtual void | OpenToken(const TDesC &, MCTToken *&, TRequestStatus &) |
| pure virtual void | OpenToken(TCTTokenHandle, MCTToken *&, TRequestStatus &) |
| pure virtual void | Release() |
| pure virtual TUid | Type() |
A token type.
This abstract class is instantiated using the ECom Plug-in Architecture for a particular token type. It allows a list of available tokens of that type to be obtained, and particular tokens to be opened.
All implementation classes are in fact a subclass of CCTTokenType; refer to its documentation for implementation details. Client access is entirely through this M class.
The difference betweeen a token type and a token is best explained with an example. Suppose a device has two identical WIM slots, the code to handle WIMs is one token type, which will have two tokens for the two WIMs.
| void | CancelList | ( | ) | [pure virtual] |
Cancels an asynchronous List() operation.
The operation completes with KErrCancel.
| void | CancelOpenToken | ( | ) | [pure virtual] |
Cancels an asynchronous OpenToken() operation.
The operation completes with KErrCancel.
| const TDesC & | Label | ( | ) | const [pure virtual] |
Gets the label of the token type.
This function is implemented by CCTTokenType, so token type implementers need not implement it.
Returns: The label to the token type.
| void | List | ( | RCPointerArray< HBufC > & | aTokens, |
| TRequestStatus & | aStatus | |||
| ) | [pure virtual] | |||
Lists all the tokens of this type.
This is an asynchronous request.
Tokens are defined by name, so instead of returning a CCTTokenTypeInfo object, this function just gives a list of pointers to HBufC objects.
| Parameter | Description |
|---|---|
| aTokens | On return, a list of all the tokens. |
| aStatus | The request status object; contains the result of the List() request when complete. Set to KErrCancel if an outstanding request is cancelled. |
| MCTTokenType * | NewL | ( | const CCTTokenTypeInfo & | aInfo, |
| RFs | aFs | |||
| ) | [static, inline] | |||
Creates a MCTTokenType given it's CCTTokenTypeInfo
The definition of this inline function is in CCTTokenType.h. If you call this function, you need to link against ctfinder.dll as well as ctframework.dll
Creates a MCTTokenType object given it's CCTTokenTypeInfo.
| Parameter | Description |
|---|---|
| aInfo | Information about the token type. |
| aFs | An open file server session. |
Returns: The new token type object.A new token type object.
| MCTTokenType * | NewL | ( | TUid | aUID, |
| RFs | aFs | |||
| ) | [static, inline] | |||
Creates a MCTTokenType given the UID of the token type.
The definition of this inline function is in CCTTokenType.h. If you call this function, you need to link against ctfinder.dll as well as ctframework.dll
Creates a MCTTokenType object given the UID of the token type.
| Parameter | Description |
|---|---|
| aUID | The UID of the token type. |
| aFs | An open file server session. |
Returns: A new token type object.A new token type object.
| void | OpenToken | ( | const TDesC & | aTokenInfo, |
| MCTToken *& | aToken, | |||
| TRequestStatus & | aStatus | |||
| ) | [pure virtual] | |||
Opens the specified token.
| Parameter | Description |
|---|---|
| aTokenInfo | Information about the required token. |
| aToken | On return, the token to be opened. |
| aStatus | The request status object; contains the result of the OpenToken() request when complete. Set to KErrCancel if an outstanding request is cancelled. |
| void | OpenToken | ( | TCTTokenHandle | aHandle, |
| MCTToken *& | aToken, | |||
| TRequestStatus & | aStatus | |||
| ) | [pure virtual] | |||
Opens the specified token.
| Parameter | Description |
|---|---|
| aHandle | The handle of the token. |
| aToken | On return, the token to be opened. |
| aStatus | The request status object; contains the result of the OpenToken() request when complete. Set to KErrCancel if an outstanding request is cancelled. |
| void | Release | ( | ) | [pure 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.
| TUid | Type | ( | ) | const [pure virtual] |
Gets the UID of the token type.
This function is implemented by CCTTokenType, so token type implementers need not implement it.
Returns: The UID of the token type.