CIdleFinder Class Reference

#include <app/cntdb.h>

Link against: cntmodel.lib

class CIdleFinder : public CIdle, public CIdle

Inherits from

CIdleFinder
- CIdle
  - CActive
    - CBase
- CIdle
  - CActive
    - CBase

Public Member Functions
	~CIdleFinder()
IMPORT_C TInt	Error()
IMPORT_C TBool	IsComplete()
virtual TInt	RunError(TInt)
IMPORT_C CContactIdArray *	TakeContactIds()

Inherited Attributes
	CActive::iStatus
	CIdle::iCallBack

Inherited Enumerations
	CActive:TPriority

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CIdle::CIdle(TInt)
	CIdle::New(TInt)
	CIdle::NewL(TInt)
	CIdle::RunL()
	CIdle::Start(TCallBack)
	CIdle::~CIdle()

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

Constructor & Destructor Documentation

~CIdleFinder ( )

~CIdleFinder

(

)

CIdleFinder destructor.

Member Function Documentation

Error ( )

IMPORT_C TInt

Error

(

)

const

Get the last asynchronous find error.

Return Value: The last asynchronous find error. Signals an error while searching the database. The error code, if any error occurs during the search operation.

IsComplete ( )

IMPORT_C TBool

IsComplete

(

)

const

Determine if the asynchronous find is complete.

Return Value: ETrue If asynchronous find is complete, EFalse otherwise. Checks whether the contact database search is complete. ETrue if search is complete, otherwise EFalse.

RunError ( TInt )

TInt

RunError

(

TInt

aError

)

[virtual]

Reimplemented from CActive::RunError(TInt)

TakeContactIds ( )

IMPORT_C CContactIdArray *

TakeContactIds

(

)

Get and take ownership of the Contact IDs.

Return Value: Array of Contact IDs. Gets an array of contact item IDs where the match is found. Array of contact item IDs.