Skip to main content

​
ChkControl_Reset

CAPL Functions » Test Service Library » Commands to Control Checks » ChkControl_Reset Valid for: CANoe DE • CANoe:lite DE • CANoe4SW DE • CANoe4SW:lite DE

​
Function Syntax

long ChkControl_Reset(dword aCheckId);

​
Method Syntax

Method Syntax 
check.Reset();

​
Description

The status (stored values) of the check is initialized. The check does not have to be stopped for this function to work.

​
Parameters

  • aCheckId: Must exist

​
Return Values

  • 0: successful
  • < 0: error

​
Possible Errors

  • Check for given id does not exist
  • Check was already in the resulting lifecycle state (was reset)

​
Example

dword checkId;
dword numCheckEvents;

// start the Error Frame observation
checkId = ChkStart_ErrorFramesOccured();
// Add check as condition
TestAddCondition(checkId);
// sequence of different actions and waiting conditions
TestWaitForTimeout(1000);
// Remove check as condition
TestRemoveCondition(checkId);

// stop the check
ChkControl_Stop(checkId);

// reset stored values of the check
ChkControl_Reset(checkId);

// start the check again without adding as condition
ChkControl_Start(checkId);
// sequence of different actions and waiting conditions
TestWaitForTimeout(1000);
// stop the check
ChkControl_Stop(checkId);

// analysis of check
numCheckEvents = ChkQuery_NumEvents(checkId);
if (numCheckEvents > 0)
   TestStepFail("Error Frame occurred!");