Skip to main content

​
ChkControl_Destroy

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

​
Function Syntax

long ChkControl_Destroy(dword aCheckId);

​
Constructor

Constructor 
check.Destroy();

​
Description

The check is destroyed and cannot be accessed anymore. Its resources are freed.

​
Parameters

  • aCheckId: Must exist

​
Return Values

  • 0: successful
  • < 0: error

​
Possible Errors

  • Check for given id does not exist

​
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);

// destroy check
ChkControl_Destroy(checkId);