PCAN-Basic.NET Library Documentation
WorkerClear
Removes all filtering criteria from the message filter of the default receive queue (index 0).
Definition
Namespace: Peak.Can.Basic
Assembly: PCANBasic.NET (in PCANBasic.NET.dll) Version: 4.9.0
Assembly: PCANBasic.NET (in PCANBasic.NET.dll) Version: 4.9.0
C#
public void ClearFilters()VB
Public Sub ClearFiltersC++
public:
void ClearFilters()Example
The following example shows how to remove all filtering criteria from the message filter of the default receive queue (index 0).
C#
// Create the object using the default configuration
//
Worker myWorker = new Worker();
// Set the filter of the default receive queue (index 0) to receive only echo messages with ID 0x15
//
FilteringCriterion criterion = new FilteringCriterion();
criterion.SetMessageType(MessageType.Echo, FilterBehavior.Include);
if (myWorker.AddFilter(criterion))
{
criterion.SetSingleId(0x15, FilterMode.Extended);
if (myWorker.AddFilter(criterion))
Console.WriteLine("Receiving only Echo messages with extended ID equals to 0x15...");
else
Console.WriteLine("The given filter is already registered.");
}
else
Console.WriteLine("The given filter is already registered.");
// All filtering criteria from the message filter of the default receive queue (index 0) are removed
//
myWorker.ClearFilters();
Console.WriteLine("All filtering criteria were removed.");VB
' Create the object using the default configuration
'
Dim myWorker As Worker = New Worker()
' Set the filter of the default receive queue (index 0) to receive only echo messages with ID 0x15
'
Dim criterion As FilteringCriterion = New FilteringCriterion()
criterion.SetMessageType(MessageType.Echo, FilterBehavior.Include)
If myWorker.AddFilter(criterion) Then
criterion.SetSingleId(&H15, FilterMode.Extended)
If myWorker.AddFilter(criterion) Then
Console.WriteLine("Receiving only Echo messages with extended ID equals to 0x15...")
Else
Console.WriteLine("The given filter is already registered.")
End If
Else
Console.WriteLine("The given filter is already registered.")
End If
' All filtering criteria from the message filter of the default receive queue (index 0) are removed
'
myWorker.ClearFilters()
Console.WriteLine("All filtering criteria were removed.")C++
// Create the object using the default configuration
//
Worker^ myWorker = gcnew Worker();
// Set the filter of the default receive queue (index 0) to receive only echo messages with ID 0x15
//
FilteringCriterion criterion;
criterion.SetMessageType(MessageType::Echo, FilterBehavior::Include);
if (myWorker->AddFilter(criterion))
{
criterion.SetSingleId(0x15, FilterMode::Extended, FilterBehavior::Include);
if (myWorker->AddFilter(criterion))
Console::WriteLine("Receiving only Echo messages with extended ID equals to 0x15...");
else
Console::WriteLine("The given filter is already registered.");
}
else
Console::WriteLine("The given filter is already registered.");
// All filtering criteria from the message filter of the default receive queue (index 0) are removed
//
myWorker->ClearFilters();
Console::WriteLine("All filtering criteria were removed.");