Skip to main content
Open topic with navigation CAPL Functions » ISO11783 » Virtual Terminal Interaction Layer (VT IL) » VTIL_GetActiveMask

​
VTIL_GetActiveMask

Valid for: CANoe DE • CANoe4SW DE

​
Function Syntax

  • long VTIL_GetActiveMask(dword & maskId); // form 1
  • long VTIL_GetActiveMask(dbNode vt, dword & maskId); // form 2

​
Description

Returns object ID of the active Data or Alarm Mask.

​
Parameters

  • vt: VT simulation node to apply the function
  • maskId: Returns object ID of the active data- or alarm mask

​
Return Values

  • 0: Function has been executed successfully
  • < 0: An error has occurred, see IL Error Code

​
Example

Example for test node 
long result;
dword maskId;
result = VTIL_GetActiveMask(VT, maskId);
switch (result)
{
  case 0:
    write("ID of current mask is %u", maskId);
    TestStepPass();
    break;
  case -2104: TestStepFail("Currently there is no active Working Set!"); break;
  case -2106: TestStepFail("Currently there is no active Data or Alarm mask!"); break;
  default:    TestStepFail("Unexpected error!"); break;
}