Channel API for LabVIEW
This topic lists the LabVIEW VIs for the NI-CAN Channel API and describes the format, purpose, and parameters for each VI. The VIs in this topic are listed alphabetically.
Unless otherwise stated, each NI-CAN VI suspends execution of the calling thread until it completes.
Section Headings
The following are section headings found in the Channel API for LabVIEW VIs.
Purpose
Each VI description includes a brief statement of the purpose of the VI.
Format
The format section describes the format of each VI.
Input and Output
The input and output parameters for each VI are listed.
Description
The description section gives details about the purpose and effect of each VI.
List of VIs
The following table is an alphabetical list of the NI-CAN VIs for the Channel API.
| Channel API for LabVIEW VIs | |
|---|---|
| Function | Purpose |
| CAN Clear | Stop communication for the task and then clear the configuration. |
| CAN Clear with NI-DAQ | Stop and clear the CAN task and the NI-DAQ task synchronized with CAN Sync Start with NI-DAQ.vi. |
| CAN Clear with NI-DAQmx | Stop and clear the CAN task and the NI-DAQmx task synchronized with CAN Sync Start with NI-DAQmx.vi. |
| CAN Clear Multiple with NI-DAQ | Stop and clear the list of CAN tasks and the list of NI-DAQ tasks synchronized with CAN Sync Start Multiple with NI-DAQ.vi. |
| CAN Clear Multiple with NI-DAQmx | Stop and clear the list of CAN tasks and the list of NI-DAQmx tasks synchronized with See CAN Sync Start Multiple with NI-DAQmx.vi. |
| CAN Connect Terminals | Connect terminals in the CAN hardware. |
| CAN Create Message | Create a message configuration and associated channel configurations within the LabVIEW application. |
| CAN Create MessageEx | Create a message configuration and associated channel configurations within the LabVIEW application. In addition you can specify mode dependent channels with CAN Create MessageEx.vi. For more information about mode dependent channels, refer to Mode Dependent Channels. |
| CAN Disconnect Terminals | Disconnect terminals in the CAN hardware. |
| CAN Get Names | Get an array of CAN channel names or message names from MAX or a CAN database file. |
| CAN Get Property | Get a property for the task, or a single channel within the task. The poly VI selection determines the property to get. |
| CAN Initialize | Initialize a task for the specified channel list. |
| CAN Init Start | Initialize a task for the specified channel list, then start communication. |
| CAN Read | Read samples from a CAN task initialized as input. Samples are obtained from received CAN messages. The poly VI selection determines the data type to read. |
| CAN Set Property | Set a property for the task, or a single channel within the task. The poly VI selection determines the property to set. |
| CAN Start | Start communication for the specified task. |
| CAN Stop | Stop communication for the specified task. |
| CAN Sync Start with NI-DAQ | Synchronize and start the specified CAN task and NI-DAQ task. |
| CAN Sync Start with NI-DAQmx | Synchronize and start the specified CAN task and NI-DAQmx task. |
| CAN Sync Start Multiple with NI-DAQ | Synchronize and start the specified list of multiple CAN tasks and NI-DAQ tasks. This is a more complex implementation of CAN Sync Start with NI-DAQ.vi that supports multiple CAN and a single NI-DAQ hardware product. |
| CAN Sync Start Multiple with NI-DAQmx | Synchronize and start the specified list of multiple CAN tasks and NI-DAQmx tasks. This is a more complex implementation of CAN Sync Start with NI-DAQmx.vi that supports multiple CAN and a single NI-DAQmx hardware product. |
| CAN Write | Write samples to a CAN task initialized as Output. (Refer to the mode parameter of CAN Init Start.vi.) Samples are placed into transmitted CAN messages. The poly VI selection determines the data type to write. |