EPOC   SDK Home Glossary Indexes Previous Next Up

CIdleFinder class


Contents


CIdleFinder class — Asynchronous search information

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

CBase

Abstract: CBase behaviour.

CActive

Abstract: active object: provides facilities to encapsulate an asynchronous service, and to handle its completion using RunL().

CIdle

Invokes callback when no higher-priority active object can be scheduled.

Defined in

cntdb.h

Link against

cntmodel.lib

Description

A CIdle–derived class which provides information about the progress of an asynchronous contact database search, and which may be used to retrieve the results of the search.

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


Search information


IsComplete() — Is search complete ?

TBool IsComplete() const;

Description

Use this function to find out whether the 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.


Error() — Check for error

TInt Error() const;

Description

When the search is complete this function should be called to check for errors.

Return value

TInt

Error code: see error codes.


Retrieve search results


TakeContactIds() — Get results of the search

CContactIdArray* TakeContactIds();

Description

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

Return value

CContactIdArray*

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

EPOC       SDK Home Glossary Indexes Previous Next Up