Skip to main content
Open topic with navigation CAPL Functions » System Variables » sysSetVariableFilterActive

​
sysSetVariableFilterActive

Valid for: CANoe DE • CANoe:lite DE • CANoe4SW DE • CANoe4SW:lite DE

​
Function Syntax

long sysSetVariableFilterActive(dword active); // form 1
long sysSetVariableFilterActive(dword active, char filterName[]); // form 2

​
Description

Activates or deactivates a variable filter. If no filterName is given, the default filter is affected.

​
Parameters

  • active: Specifies the new filter status:
    • 0: deactivated.
    • All other values: activated.
  • filterName: The name of the filter that should be affected. Note: An empty filterName refers to the default filter and can be omitted completely.

​
Return Values

  • 0: No error, function successful.
  • 2: The filter does not exist. The filter status cannot be changed.

​
Example

long result;
//create the default filter as a Stop Filter.
result = sysCreateVariableFilter(0);
//deactivate the default filter.
result = sysSetVariableFilterActive(0);
SysCreateVariableFilter • SysFilterAddNamespace • SysFilterAddVariable • SysFilterRemoveNamespace • SysFilterRemoveVariable