Api Class

PCAN-Basic API class implementation.

Definition

Namespace: Peak.Can.Basic
Assembly: PCANBasic.NET (in PCANBasic.NET.dll) Version: 4.8.2
C#
public static class Api
Inheritance
Object    Api

Remarks

This class allows access to the underlying PCAN-Basic API.

Methods

FilterMessages Configures the acceptance filter for CAN messages within a PCAN Channel.
GetAttachedChannels Retrieves information about the PCAN Channels attached to the system.
GetErrorText(PcanStatus, String) Returns a descriptive text of a given error code, using the operating system language, or English, if it is not supported.
GetErrorText(PcanStatus, String, OutputLanguage) Returns a descriptive text of a given error code, using a custom output language.
GetHandleInformation Retrieves information about device type and channel number from a PCAN Handle
GetStatus Retrieves the current status of the CAN controller of the hardware represented by a PCAN Channel.
GetValue(PcanChannel, PcanParameter, PcanChannelInformation) Retrieves an array of PcanChannelInformation with information about the hardware currently attached to the system.
GetValue(PcanChannel, PcanParameter, String) Retrieves a string parameter value from a PCAN Channel.
GetValue(PcanChannel, PcanParameter, UInt32) Retrieves a 32-bit numeric parameter value from a PCAN Channel.
GetValue(PcanChannel, PcanParameter, UInt64) Retrieves a 64-bit numeric parameter value from a PCAN Channel.
Initialize(PcanChannel, Bitrate) Initializes a PCAN Channel for classic CAN communication.
Initialize(PcanChannel, BitrateFD) Initializes a PCAN Channel for CAN communication supporting flexible data rate.
LookUpChannel Finds the handle of a PCAN Channel that matches the given parameters.
Read(PcanChannel, PcanMessage) Reads a CAN message from the receive queue of a PCAN Channel.
Read(PcanChannel, PcanMessage, UInt64) Reads a CAN message and its timestamp from the receive queue of a PCAN Channel.
Reset Discards all messages contained in the receive and transmit queues of a PCAN Channel.
SetValue(PcanChannel, PcanParameter, String) Configures a string parameter value of a PCAN Channel.
SetValue(PcanChannel, PcanParameter, UInt32) Configures a 32-bit numeric parameter value of a PCAN Channel.
SetValue(PcanChannel, PcanParameter, UInt64) Configures a 64-bit numeric parameter value of a PCAN Channel.
Uninitialize Uninitializes one or all PCAN Channels initialized by the methods Initialize and Initialize.
Write Places a CAN message in the transmit queue of a PCAN Channel.

See Also