TCTTokenObjectHandle Class Reference

#include <ct/tcttokenobjecthandle.h>

Link against: ctframework.lib

class TCTTokenObjectHandle

Detailed Description

Defines a handle to an object represented by a class which is a subclass of the MCTTokenObject class.

The handle identifies the object, not the instance of the subclass of MCTTokenObject used to manage that object. It is guaranteed to be unique within the context of a specific device (e.g. mobile phone, etc.) at a specific point in time. This limitation in time is due to the fact that objects can be created and destroyed. We cannot guarantee that a handle will still point to the same object after we add or remove one or more objects from the store from which the object comes. However, it is guaranteed that the addition of objects to the store will not affect the validity of the handles that were obtained previously. For instance, if the object is a certificate in a certificate store, the subclass of MCTTokenObject will be CCTCertInfo and the handle will identify the certificate in the certificate store, not the instance of CCTCertInfo.

The handle is especially useful for communication across process boundaries. For example: a process (A) can get a handle to an object, and then give the handle to another process (B). This process (B) can then try to get the same object using that handle.

Since
v7.0

Member Attribute Documentation

iObjectId

TInt iObjectId

The identifier of the object within the Token.

This is unique within the context of a particular Token and only at a specific point in time.

iTokenHandle

TCTTokenHandle iTokenHandle

The handle that identifies the Token where the object is stored.

Constructor & Destructor Documentation

TCTTokenObjectHandle ( )

IMPORT_CTCTTokenObjectHandle()

Creates an invalid handle.

An invalid handle has an invalid iTokenHandle and an iObjectId equal to 0.

TCTTokenObjectHandle ( TCTTokenHandle, TInt )

IMPORT_CTCTTokenObjectHandle(TCTTokenHandleaTokenHandle,
TIntaObjectId
)

Creates a handle.

ParameterDescription
aTokenHandleThe handle that identifies the Token where the object is stored.
aObjectIdThe identifier of the object within the Token.

TCTTokenObjectHandle ( const TCTTokenObjectHandle & )

IMPORT_CTCTTokenObjectHandle(const TCTTokenObjectHandle &aTokenHandle)

Copy Constructor.

ParameterDescription
aTokenHandleThe handle to copy.

Member Function Documentation

operator!= ( const TCTTokenObjectHandle & )

TBool operator!=(const TCTTokenObjectHandle &aTokenHandle)const [inline]

Inequality operator

operator== ( const TCTTokenObjectHandle & )

IMPORT_C TBooloperator==(const TCTTokenObjectHandle &aTokenHandle)const

Equality operator.

Tests whether this TCTTokenObjectHandle object is equal to the specified TCTTokenObjectHandle object.

ParameterDescription
aTokenHandleThe TCTTokenObjectHandle object to be compared.

Returns: ETrue, if thisTCTTokenObjectHandle object is equal to the specified TCTTokenObjectHandle object; EFalse otherwise.