Class CIdleFinder

CIdleFinder

Support

Supported from 5.0

Description

Gives information about the progress of an asynchronous contact database search, and can be used to get the results of the search.

An instance of this class is returned by calls to CContactDatabase::FindAsyncL() and CContactDatabase::FindInTextDefAsyncL().

Derivation

CActive The core class of the active object abstraction CBase Base class for all classes to be instantiated on the heap CIdle An active object that performs low-priority processing when no higher-priority active objects are ready to run CIdleFinder Gives information about the progress of an asynchronous contact database search, and can be used to get the results of the search

Defined in CIdleFinder:
Error(), IsComplete(), TakeContactIds()

Inherited from CActive:
Cancel(), Deque(), DoCancel(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, IsActive(), IsAdded(), Priority(), RunError(), RunL(), SetActive(), SetPriority(), TPriority, iStatus

Inherited from CBase:
operator new()

Inherited from CIdle:
New(), NewL(), Start()

TBool IsComplete() const;

Description

Tests whether a search is complete. It should be used in an implementation of the callback function MIdleFindObserver::IdleFindCallback().

Return value

TBool ETrue if the search is complete. EFalse if the search is not complete.

TInt Error() const;

Description

Checks for errors when the search is complete.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

CContactIdArray* TakeContactIds();

Description

Gives access to and takes ownership of the array of contact items found in the search.

Return value

CContactIdArray* Pointer to an array of contact item IDs which identify the contact items found by the search.