Class CIdleFinder

class CIdleFinder : public CIdle;

Description

Provides 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

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

• CActive - The core class of the active object abstraction

• CIdle - An active object that performs low-priority processing when no higher-priority active objects are ready to run

• CIdleFinder - Provides information about the progress of an asynchronous contact database search, and can be used to get the results of the search

Members

Defined in CIdleFinder:

• DoCancel()Implements cancellation of an outstanding request
• Error()Signals an error while searching the database
• IsComplete()Checks whether the contact database search is complete
• RunError()
• TakeContactIds()Gets an array of contact item IDs where the match is found

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

Inherited from CIdle:

• New()Allocates and initialises an Idle time active object and adds it to the active scheduler
• NewL()Allocates and initialises an Idle time active object, adds it to the active scheduler, but leaves on failure
• RunL()Handles this idle active object's request completion event
• Start()Starts the background task
• iCallBackThe callback object that encapsulates the background task

IMPORT_C TBool IsComplete() const;

Description

Checks whether the contact database search is complete.

Return value

TBool ETrue if search is complete, otherwise EFalse.

IMPORT_C CContactIdArray *TakeContactIds();

Description

Gets an array of contact item IDs where the match is found.

Return value

CContactIdArray * Array of contact item IDs.

IMPORT_C TInt Error() const;

Description

Signals an error while searching the database.

Return value

TInt The error code, if any error occurs during the search operation.

virtual TInt RunError(TInt aError);

Description

Parameters

TInt aError

Return value

TInt

private: virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().