Collapse all Symbian^3 Application Developer Library

RTestModule Class Reference

class RTestModule : public RSubSessionBase

Inherits from

RTestModule
- RSubSessionBase

Public Member Functions
IMPORT_C TInt	CancelAsyncRequest ( TInt )
IMPORT_C void	Close ()
IMPORT_C void	EnumerateTestCases ( TDesC &, TCaseSize &, TRequestStatus &)
IMPORT_C void	ErrorNotification ( TErrorNotificationPckg &, TRequestStatus &)
IMPORT_C TInt	GetTestCases ( CFixedFlatArray < TTestCaseInfo > &)
IMPORT_C TInt	Open ( RTestServer &, TFileName &)

Inherited Functions
	RSubSessionBase::CloseSubSession(TInt)
	RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::RSubSessionBase()
	RSubSessionBase::Send(TInt)const
	RSubSessionBase::Send(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt)const
	RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSubSessionBase::Session()const
	RSubSessionBase::SubSessionHandle()const

Member Functions Documentation

CancelAsyncRequest(TInt)

IMPORT_C TInt

CancelAsyncRequest

(

TInt

aReqToCancel

)

Asynchronous request can be canceled with CancelAsyncRequest method. The aReqToCancel parameter defines the request that will be canceled.

Parameters

TInt aReqToCancel

Close()

IMPORT_C void

(

)

Closes the RTestModule subsession.

EnumerateTestCases(TDesC &, TCaseSize &, TRequestStatus &)

IMPORT_C void	EnumerateTestCases	(	TDesC &	aConfigFile,
			TCaseSize &	aCount,
			TRequestStatus &	aStatus
		)

EnumerateTestCases requests the needed array size for test cases that will be inquired by GetTestCases method. The aConfigFile specifies the ( optional ) config file where test cases are defined for this query. When the EnumerateTestCases is completed succesfully the GetTestCases method is called to retrieve test cases to CArrayFixFlat<RTestEngine::TTestInfo> list object.

Parameters

TDesC & aConfigFile
TCaseSize & aCount
TRequestStatus & aStatus

ErrorNotification(TErrorNotificationPckg &, TRequestStatus &)

IMPORT_C void	ErrorNotification	(	TErrorNotificationPckg &	aError,
			TRequestStatus &	aStatus
		)

Parameters

TErrorNotificationPckg & aError
TRequestStatus & aStatus

GetTestCases(CFixedFlatArray< TTestCaseInfo > &)

IMPORT_C TInt

GetTestCases

(

CFixedFlatArray < TTestCaseInfo > &

aTestCaseBuffer

)

GetTestCases is used to synchronously get test cases from Test Server. The list of test cases is retrieved to aTestCaseBuffer. Test Engine allocates needed memory for the test case array by calling EnumerateTestCases to inquire needed size of aTestCaseBuffer.

If this method is called without previously succesfully called EnumerateTestCases the Test Server shall return KErrNotReady.

Parameters

CFixedFlatArray < TTestCaseInfo > & aTestCaseBuffer

Open(RTestServer &, TFileName &)

IMPORT_C TInt	Open	(	RTestServer &	aServer,
			TFileName &	aIniFile
		)

Open creates a subsession to Test Server and opens handle. The RTestServer server session shall be created by calling RTestServer::Connect before calling this function to create new RTestModule subsession.

Parameters

RTestServer & aServer
TFileName & aIniFile