ApiUninitialize Method

Uninitializes one or all PCAN Channels initialized by the methods Initialize and Initialize.

Definition

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

public static PcanStatus Uninitialize(
	PcanChannel channel
)

Public Shared Function Uninitialize ( 
	channel As PcanChannel
) As PcanStatus

C++

public:
static PcanStatus Uninitialize(
	PcanChannel channel
)

Parameters

channel PcanChannel: The handle of a PCAN Channel.

Return Value

PcanStatus

OK is returned on success. The typical errors in case of failure are:

Initialize: Indicates that the channel cannot be terminated because it was not found in the list of reserved Channels of the calling application.
IllegalHandle: Indicates that the channel contains an invalid value.

Remarks

This method can be used to achieve two different goals:

To release a single Channel: Passing the handle of a PCAN Channel initialized before as parameter (see Initialize / Initialize) terminates the connection with that Chanel. If the given channel cannot be found, an error is returned.
To release all connected Channels: Passing the Channel None as parameter, terminates all connections, that have been issued and maintained by the calling application. This operation does not generate errors if no Channels were found and terminated.

Important

When a connection is terminated, the underlying hardware's transmit queue will not be immediately discarded. The API will wait some time before terminating, so that the hardware has time to send (or try to send) the unsent messages. When this time runs out (about 500 milliseconds), the rest of the messages in the queue (if any) are discarded.

Example

The following example shows the single release process using the USB interface (first PCAN-USB hardware).

In case of failure, the returned code will be translated to a text (according with the operating system language) in English, German, Italian, French or Spanish, and it will be shown to the user.

PcanChannel channel = PcanChannel.Usb01;

// The hardware represented by the given handle is initialized with 500 kBit/s nominal and 4 MBit/s data bit rate (SAE J2284-4)
//
PcanStatus result = Api.Initialize(channel, (BitrateFD)BitrateFD.BitrateSaeJ2284_4);
if (result != PcanStatus.OK)
{
    // An error occurred
    //
    Api.GetErrorText(result, out var errorText);
    Console.WriteLine(errorText);
}
else
{
    // A success message is shown
    //
    Console.WriteLine($"The hardware represented by the handle {channel} was successfully initialized.");
    // The connection to the hardware is finalized when it is no longer needed
    //
    result = Api.Uninitialize(channel);
    if (result != PcanStatus.OK)
    {
        // An error occurred
        //
        Api.GetErrorText(result, out var errorText);
        Console.WriteLine(errorText);
    }
    else
        Console.WriteLine($"The hardware represented by the handle {channel} was successfully finalized.");
}

Dim channel As PcanChannel = PcanChannel.Usb01

' The hardware represented by the given handle is initialized with 500 kBit/s nominal and 4 MBit/s data bit rate (SAE J2284-4)
'
Dim result As PcanStatus = Api.Initialize(channel, CType(BitrateFD.BitrateSaeJ2284_4, BitrateFD))
If (result <> PcanStatus.OK) Then
    ' An error occurred
    '
    Dim errorText As String = String.Empty
    Api.GetErrorText(result, errorText)
    Console.WriteLine(errorText)
Else
    ' A success message is shown
    '
    Console.WriteLine($"The hardware represented by the handle {channel} was successfully initialized.")
    ' The connection to the hardware Is finalized when it is no longer needed
    '
    result = Api.Uninitialize(channel)
    If (result <> PcanStatus.OK) Then
        ' An error occurred
        '
        Dim errorText As String = String.Empty
        Api.GetErrorText(result, errorText)
        Console.WriteLine(errorText)
    Else
        Console.WriteLine($"The hardware represented by the handle {channel} was successfully finalized.")
    End If
End If

C++

String^ errorText;
PcanChannel channel = PcanChannel::Usb01;

// The hardware represented by the given handle is initialized with 500 kBit/s nominal and 4 MBit/s data bit rate (SAE J2284-4)
//
PcanStatus result = Api::Initialize(channel, (BitrateFD^)BitrateFD::BitrateSaeJ2284_4);
if (result != PcanStatus::OK)
{
    // An error occurred
    //
    Api::GetErrorText(result, errorText);
    Console::WriteLine(errorText);
}
else
{
    // A success message is shown
    //
    Console::WriteLine("The hardware represented by the handle {0} was successfully initialized.", channel);
    // The connection to the hardware is finalized when it is no longer needed
    //
    result = Api::Uninitialize(channel);
    if (result != PcanStatus::OK)
    {
        // An error occurred
        //
        Api::GetErrorText(result, errorText);
        Console::WriteLine(errorText);
    }
    else
        Console::WriteLine("The hardware represented by the handle {0} was successfully finalized.", channel);
}

The following example shows the multiple release process using the USB interface (first and second PCAN-USB hardware).