Frame API for LabVIEW
This topic lists the LabVIEW VIs for the NI-CAN Frame 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 Frame 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.
Network Interface Object
The Network Interface Object section gives details about using the VI with the Network Interface Object.
CAN Object
The CAN Object section gives details about using the VI with the CAN Object.
List of VIs
The following table is an alphabetical list of the NI-CAN VIs for the Frame API.
| Function | Purpose |
|---|---|
| ncAction.vi | Perform an action on an object. |
| ncClose.vi | Close an object. |
| ncConfigCANNet.vi | Configure a CAN Network Interface Object before opening it. |
| ncConfigCANNetRTSI.vi | Configure a CAN Network Interface Object with RTSI features. |
| ncConfigCANObj.vi | Configure a CAN Object before using it. |
| ncConfigCANObjRTSI.vi | Configure a CAN Object with RTSI features. |
| ncConnectTerminals.vi | Connect terminals in the CAN or LIN hardware. |
| ncDisconnectTerminals.vi | Disconnect terminals in the CAN or LIN hardware. |
| ncGetAttr.vi | Get the value of an object attribute. |
| ncGetHardwareInfo.vi | Get NI-CAN hardware information. |
| ncGetTimer.vi | Get the absolute timestamp attribute. |
| ncOpen.vi | Open an object. |
| ncReadNet.vi | Read single frame from a CAN Network Interface Object. |
| ncReadNetMult.vi | Read multiple frames from a CAN Network Interface Object. |
| ncReadObj.vi | Read single frame from a CAN Object. |
| ncReadObjMult.vi | Read multiple frames from a CAN Object. |
| ncSetAttr.vi | Set the value of an object attribute. |
| ncWaitForState.vi | Wait for one or more states to occur in an object. |
| ncWriteNet.vi | Write a single frame to a CAN Network Interface Object. |
| ncWriteNetMult.vi | Write multiple frames to a CAN Network Interface Object. |
| ncWriteObj.vi | Write a single frame to a CAN Object. |