Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: CNTDB.H
Link against: cntmodel.lib

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

Members

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

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

Inherited from CBase:
Delete(), operator new()

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


Member functions


IsComplete()

IMPORT_C TBool IsComplete() const;

Description

Checks whether the contact database search is complete.

Return value

TBool

ETrue if search is complete, otherwise EFalse.


TakeContactIds()

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.


Error()

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.


RunError()

virtual TInt RunError(TInt aError);

Description

Parameters

TInt aError

Return value

TInt


DoCancel()

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().