WorkerRemoveBroacast(Int32) Method

Removes a periodic CAN message from the list of registered Broadcast objects.

Definition

Namespace: Peak.Can.Basic
Assembly: PCANBasic.NET (in PCANBasic.NET.dll) Version: 4.9.0

public bool RemoveBroacast(
	int index
)

Public Function RemoveBroacast ( 
	index As Integer
) As Boolean

C++

public:
bool RemoveBroacast(
	int index
)

Parameters

index Int32: Represents the zero-based index associated to a Broadcast object.

Return Value

Boolean
true if the Broadcast object was removed; false otherwise.

Remarks

If a Broadcast object needs to be temporarily deactivated, it is not needed to delete it and create it again. Single Broadcast objects can be temporarily deactivated using the PauseBroadcast method and reactivated again using the ResumeBroadcast method. Using the property MessageBroadcasting is possible to activate/deactivate the Broadcast object processing.

Example

The following example shows how to remove a Broadcast object.

In case of failure, an error messages is written to the console output using English as output language.

// Create the object using the default configuration
//
Worker myWorker = new Worker();

// Create the CAN message to broadcast
//
PcanMessage message = new PcanMessage(0x100, MessageType.Standard, 3, new byte[] { 1, 2, 3 }, false);

// Add the new broadcast using a CAN message and its interval
//
int index = myWorker.AddBroadcast(message, 100);
if (index < 0)
{
    Console.WriteLine("The broadcast couldn't be configured");
}
else
{
    Console.WriteLine($"The broadcast object with index '{index}' was configured successfully.");

    try
    { 
        // Activate the worker object
        //
        myWorker.Start();
        Console.WriteLine("The Worker object was activated successfully.");

        // Wait sometime for the message to be sent several times
        //
        Console.WriteLine("Broadcast is working....");
        System.Threading.Thread.Sleep(5000);

        // Remove the broadcast using an index
        //
        if(myWorker.RemoveBroacast(index))
        {
            Console.WriteLine($"The broadcast object with index '{index}' was successfully removed.");

            // Wait sometime to see the message is no being sent anymore
            //
            System.Threading.Thread.Sleep(3000);
        }
        else
            Console.WriteLine($"The broadcast with index {index} couldn't be removed.");

        // Deactivate the worker object, when it is no longer needed
        //
        myWorker.Stop();
        Console.WriteLine("The Worker object was deactivated.");
    }
    catch(Exception ex)
    {
        Console.WriteLine($"An exception occurred by activating the Worker object. {ex.Message}");
    }
}

' Create the object using the default configuration
'
Dim myWorker As Worker = New Worker()

' Create the CAN message to broadcast
'
Dim message As PcanMessage = New PcanMessage(&H100, MessageType.Standard, 3, New Byte() {1, 2, 3}, False)

' Add the new broadcast using a CAN message and its interval
'
Dim index As Integer = myWorker.AddBroadcast(message, 100)

If index < 0 Then
    Console.WriteLine("The broadcast couldn't be configured")
Else
    Console.WriteLine($"The broadcast object with index '{index}' was configured successfully.")

    Try
        ' Activate the worker object
        '
        myWorker.Start()
        Console.WriteLine("The Worker object was activated successfully.")

        ' Wait sometime for the message to be sent several times
        '
        Console.WriteLine("Broadcast is working....")
        Threading.Thread.Sleep(5000)

        ' Remove the broadcast using an index
        '
        If myWorker.RemoveBroacast(index) Then
            Console.WriteLine($"The broadcast object with index '{index}' was successfully removed.")

            ' Wait sometime to see the message is no being sent anymore
            '
            Threading.Thread.Sleep(3000)
        Else
            Console.WriteLine($"The broadcast with index {index} couldn't be removed.")
        End If

        ' Deactivate the worker object, when it is no longer needed
        '
        myWorker.[Stop]()
        Console.WriteLine("The Worker object was deactivated.")
    Catch ex As Exception
        Console.WriteLine($"An exception occurred by activating the Worker object. {ex.Message}")
    End Try
End If

C++

// Create the object using the default configuration
//
Worker^ myWorker = gcnew Worker();

// Create the CAN message to broadcast
//
PcanMessage^ message = gcnew PcanMessage(0x100, MessageType::Standard, 3, gcnew array<Byte>{ 1, 2, 3 }, false);

// Add the new broadcast using a CAN message and its interval
//
int index = myWorker->AddBroadcast(message, 100);
if (index < 0)
{
    Console::WriteLine("The broadcast couldn't be configured");
}
else
{
    Console::WriteLine("The broadcast object with index '{0}' was configured successfully.", index);

    try
    {
        // Activate the worker object
        //
        PcanBasicException^ error;
        myWorker->Start(false, false, false);
        Console::WriteLine("The Worker object was activated successfully.");

        // Wait sometime for the message to be sent several times
        //
        Console::WriteLine("Broadcast is working....");
        System::Threading::Thread::Sleep(5000);

        // Remove the broadcast using an index
        //
        if (myWorker->RemoveBroacast(index))
        {
            Console::WriteLine("The broadcast object with index '{0}' was successfully removed.", index);

            // Wait sometime to see the message is no being sent anymore
            //
            System::Threading::Thread::Sleep(3000);
        }
        else
            Console::WriteLine("The broadcast with index {0} couldn't be removed.", index);

        // Deactivate the worker object, when it is no longer needed
        //
        myWorker->Stop(false, false, false);
        Console::WriteLine("The Worker object was deactivated.");
    }
    catch (Exception^ ex)
    {
        Console::WriteLine("An exception occurred by activating the Worker object. {0}", ex->Message);
    }
}

Exceptions

IndexOutOfRangeException

The index parameter value is out of range. This must be in the range [0...MaximumBroadcastCount-1].