Collapse all Symbian^3 Product Developer Library

RSearchClient Class Reference

class RSearchClient : public RSessionBase

Client side class of search service Client/Server.

This class is used to create communiatiob between ipc boundry searchclient.lib

Inherits from

RSearchClient
- RSessionBase
  - RHandleBase

Public Member Functions
	RSearchClient()
void	CancelResult()
void	CancelSearch()
TInt	Connect()
void	ContinueSearchingLightL(TPckgBuf< TInt > &, TRequestStatus &, TPckgBuf< TInt > &, TPckgBuf< TInt > &)
void	GetHeavyResultsL(RPointerArray< CSearchResult > &)
HBufC8 *	GetLaunchInfoL(const CSearchDocumentId &)
void	GetLightResultsL(RPointerArray< CSearchLightResult > &)
TInt	GetResultsL(const RPointerArray< CSearchDocumentId > &, TPckgBuf< TInt > &, TRequestStatus &)
void	GetSupportedContentL(RPointerArray< CSearchContent > &, TUid)
void	GetSupportedServicesL(RArray< TUid > &)
void	LaunchApplicationL(const CSearchDocumentId &)
TInt	SearchL(const CSearchQuery &, TPckgBuf< TInt > &, const TSearchThreshold &, TRequestStatus &, TPckgBuf< TInt > &, TPckgBuf< TInt > &)
TVersion	Version()

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RSearchClient()

RSearchClient

(

)

Constructor

Member Functions Documentation

CancelResult()

void

CancelResult

(

)

Cancels the heavy results asked.

CancelSearch()

void

CancelSearch

(

)

Cancels the currently ongoing search.

Connect()

TInt

Connect

(

)

Connects to the search server.

ContinueSearchingLightL(TPckgBuf< TInt > &, TRequestStatus &, TPckgBuf< TInt > &, TPckgBuf< TInt > &)

void	ContinueSearchingLightL	(	TPckgBuf< TInt > &	aSearchFinished,
			TRequestStatus &	aStatus,
			TPckgBuf< TInt > &	aSearchCount,
			TPckgBuf< TInt > &	aSearchRes
		)

Continuse search if it has not yet completed

Parameters

TPckgBuf< TInt > & aSearchFinished	Flag for search status
TRequestStatus & aStatus	RequestStatus.
TPckgBuf< TInt > & aSearchCount	Result count
TPckgBuf< TInt > & aSearchRes	Result Count

GetHeavyResultsL(RPointerArray< CSearchResult > &)

void

GetHeavyResultsL

(

RPointerArray< CSearchResult > &

aSearchHeavyRes

)

Gets heay resultd from server

Parameters

RPointerArray< CSearchResult > & aSearchHeavyRes

On retutn gets heavy res.

GetLaunchInfoL(const CSearchDocumentId &)

HBufC8 *

GetLaunchInfoL

(

const CSearchDocumentId &

aDocumentID

)

Get file launch information.

Parameters

const CSearchDocumentId & aDocumentID

GetLightResultsL(RPointerArray< CSearchLightResult > &)

void

GetLightResultsL

(

RPointerArray< CSearchLightResult > &

aLightResult

)

Get light results from server aLightResult Light result

Parameters

RPointerArray< CSearchLightResult > & aLightResult

GetResultsL(const RPointerArray< CSearchDocumentId > &, TPckgBuf< TInt > &, TRequestStatus &)

TInt	GetResultsL	(	const RPointerArray< CSearchDocumentId > &	aResultIDArray,
			TPckgBuf< TInt > &	aSearchFinished,
			TRequestStatus &	aStatus
		)

Sends IDs to server to get heavy res the results. Asynchronous.

Parameters

const RPointerArray< CSearchDocumentId > & aResultIDArray	The array of result ids.
TPckgBuf< TInt > & aSearchFinished	Flag for search status.
TRequestStatus & aStatus	RequestStatus

GetSupportedContentL(RPointerArray< CSearchContent > &, TUid)

void	GetSupportedContentL	(	RPointerArray< CSearchContent > &	aContent,
			TUid	aServiceId
		)

Function returning a list of support content types that can be searched by the engine. : The content Resource

Parameters

RPointerArray< CSearchContent > & aContent
TUid aServiceId

GetSupportedServicesL(RArray< TUid > &)

void

GetSupportedServicesL

(

RArray< TUid > &

aServiceIdArray

)

Gets supported service ids by the search framework.

Parameters

RArray< TUid > & aServiceIdArray

On return contains the list of supported service ids.

LaunchApplicationL(const CSearchDocumentId &)

void

LaunchApplicationL

(

const CSearchDocumentId &

aResultId

)

Launches a viewer/editor application for the given result id.

Parameters

const CSearchDocumentId & aResultId

The id of the given document.

SearchL(const CSearchQuery &, TPckgBuf< TInt > &, const TSearchThreshold &, TRequestStatus &, TPckgBuf< TInt > &, TPckgBuf< TInt > &)

TInt	SearchL	(	const CSearchQuery &	aSearchQuery,
			TPckgBuf< TInt > &	aSearchFinished,
			const TSearchThreshold &	aThreshold,
			TRequestStatus &	aStatus,
			TPckgBuf< TInt > &	aSearchCount,
			TPckgBuf< TInt > &	aSearchRes
		)

Starts the search with the specified search criteria.Async call

Parameters

const CSearchQuery & aSearchQuery
TPckgBuf< TInt > & aSearchFinished	Flag for search status
const TSearchThreshold & aThreshold	The threshold of the search process.
TRequestStatus & aStatus	RequestStatus.
TPckgBuf< TInt > & aSearchCount	Total count
TPckgBuf< TInt > & aSearchRes	Result Count

Version()

TVersion

Version

(

)

const

Returns the API version number of the server's client.