Class CContactOpenOperation

class CContactOpenOperation : private CActive;

Description

A class that manages the asynchronous open operation for a CContactDatabase.

The object can be deleted before the asynchronous open completes. This will set the state of the client supplied TRequestStatus to KErrCancel.

When the client supplied TRequestStatus is completed with KErrNone the TakeDatabase() method is called to pass ownership of the open database to the client.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CActive - The core class of the active object abstraction

• CContactOpenOperation - A class that manages the asynchronous open operation for a CContactDatabase

Members

Defined in CContactOpenOperation:

• DoCancel()For BC only, CActive is not used here
• RunError()For BC only, CActive is not used here
• RunL()For BC only, CActive is not used here
• TakeDatabase()Takes ownership of the contact database
• ~CContactOpenOperation()Deletes the active object

Inherited from CActive:

• Cancel()Cancels the wait for completion of an outstanding request
• Deque()Removes the active object from the active scheduler's list of active objects
• EPriorityHighA priority higher than EPriorityUserInput
• EPriorityIdleA low priority, useful for active objects representing background processing
• EPriorityLowA priority higher than EPriorityIdle but lower than EPriorityStandard
• EPriorityStandardMost active objects will have this priority
• EPriorityUserInputA priority higher than EPriorityStandard; useful for active objects handling user input
• Extension_()Extension function
• IsActive()Determines whether the active object has a request outstanding
• IsAdded()Determines whether the active object has been added to the active scheduler's list of active objects
• Priority()Gets the priority of the active object
• SetActive()Indicates that the active object has issued a request and that it is now outstanding
• SetPriority()Sets the priority of the active object
• TPriorityDefines standard priorities for active objects
• iStatusThe request status associated with an asynchronous request

Inherited from CBase:

• Delete()Deletes the specified object
• operator new()Initialises the object to binary zeroes

See also:

• CContactDatabase::OpenL()Opens the default contact database

Capability:

Illegal

IMPORT_C ~CContactOpenOperation();

Description

Deletes the active object.

If the asynchronous open is still in progress it is cancelled.

If the TakeDatabase() API has not been called and the database has been opened it is closed.

IMPORT_C CContactDatabase *TakeDatabase();

Description

Takes ownership of the contact database.

Ownership of the contact database is passed to the client. Subsequent calls return NULL.

Return value

CContactDatabase * A pointer to the CContactDatabase on the first call after the asynchronous open has succeeded. Otherwise NULL.

See also:

• CContactDatabase::Open()Opens the default contact database asynchronously

private: virtual void RunL();

Description

For BC only, CActive is not used here.

private: virtual TInt RunError(TInt aError);

Description

For BC only, CActive is not used here.

Parameters

TInt aError

Return value

TInt

private: virtual void DoCancel();

Description

For BC only, CActive is not used here.