RTestCase Class Reference

class RTestCase : public RSubSessionBase

Inherits from

Member Functions Documentation

CancelAsyncRequest(TInt)

IMPORT_C TIntCancelAsyncRequest(TIntaReqToCancel)

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

Parameters

TInt aReqToCancel

Close()

IMPORT_C voidClose()

Closes the RTestCase subsession. Test case is normally closed immediately after the test case was completed.

NotifyProgress(TTestProgressPckg &, TRequestStatus &)

IMPORT_C voidNotifyProgress(TTestProgressPckg &aProgress,
TRequestStatus &aStatus
)

NotifyProgress requests different progress information from the test case execution. This information can be printed to UI. The progress information is returned to aProgress. The aProgress is TTestProgressPckg that is a packaged TTestProgress

Parameters

TTestProgressPckg & aProgress
TRequestStatus & aStatus

NotifyRemoteMsg(TDes8 &, TStifCommand)

IMPORT_C TIntNotifyRemoteMsg(TDes8 &aMessage,
TStifCommandaType
)

NotifyRemoteMsg gets messages.

Parameters

TDes8 & aMessage
TStifCommand aType

NotifyRemoteType(TStifCommandPckg &, TPckg< TInt > &, TRequestStatus &)

IMPORT_C voidNotifyRemoteType(TStifCommandPckg &aType,
TPckg< TInt > &aMsgSize,
TRequestStatus &aStatus
)

NotifyRemoteType requests enable message waiting.

Parameters

TStifCommandPckg & aType
TPckg< TInt > & aMsgSize
TRequestStatus & aStatus

Open(RTestEngineServer &, const TTestInfoPckg &)

IMPORT_C TIntOpen(RTestEngineServer &aServer,
const TTestInfoPckg &aTestCaseInfo
)

Open creates a subsession for new test case. Test case is initialized using aTestCaseInfo parameter. The aTestCaseInfo is TTestInfoPckg that is a packaged TTestInfo. TTestInfo is got from the Test Engine by calling RTestEngine::GetTestCases method. If there was previously called RemoveTestModule for the Test Module that is defined in aTestCaseInfo this method returns KErrLocked. This means that new test cases cannot be run from this Test Module and the user should inquire test cases available calling RTestEngine::GetTestCases.

Parameters

RTestEngineServer & aServer
const TTestInfoPckg & aTestCaseInfo

Pause()

IMPORT_C TIntPause()

Pause suspends the execution of the test case. The subsession where the test case is run is suspended and thus the test case execution is suspended. Test case execution can be later resumed by calling Resume.

Resume()

IMPORT_C TIntResume()

Resume is used to resume the test case suspended by previously called Pause method. The test case execution should be continued immediately when the Resume is called.

RunTestCase(TFullTestResultPckg &, TRequestStatus &)

IMPORT_C voidRunTestCase(TFullTestResultPckg &aTestResult,
TRequestStatus &aStatus
)

RunTestCase is asynchronous method and it is completed when the test case is completed. Result of the test case is returned to aTestResult. The aTestResult is TFullTestResultPckg that is a packaged TFullTestResult. The aStatus will have the completion result of this function. If the test case could be run (despite of succesfully or not) the KErrNone is returned to aStatus.

Parameters

TFullTestResultPckg & aTestResult
TRequestStatus & aStatus

RunTestCase(TFullTestResultPckg &, const TDesC &, TRequestStatus &)

IMPORT_C voidRunTestCase(TFullTestResultPckg &aTestResult,
const TDesC &aTestCaseArgs,
TRequestStatus &aStatus
)

RunTestCase is asynchronous method and it is completed when the test case is completed. Result of the test case is returned to aTestResult. The aTestResult is TFullTestResultPckg that is a packaged TFullTestResult. The aStatus will have the completion result of this function. If the test case could be run (despite of succesfully or not) the KErrNone is returned to aStatus.

Parameters

TFullTestResultPckg & aTestResult
const TDesC & aTestCaseArgs
TRequestStatus & aStatus