Naming Conventions for Generated Files and Constants

FPGA Interface C API Help

Edition Date: August 2014

Part Number: 372928H-01

»View Product Info
Download Help (Windows Only)

Unless you specify a custom prefix, the FPGA Interface C API Generator names the generated .h file, the .lvbitx file, and the constants in the .h file based on the name of the FPGA VI from which the application bitfile was compiled.

Characters Permitted in File and Constant Names

The FPGA Interface C API Generator removes all characters except alphanumeric characters and underscores from the name of the FPGA VI before using the name of the VI as the prefix for the generated C API. The FPGA Interface C API Generator cannot properly process multi-byte characters such as those used in East Asian-locale Windows systems. National Instruments recommends that you use only single-byte alphanumeric characters and underscores in the names of FPGA VIs, labels of controls and indicators, and names of FIFOs so that the FPGA Interface C API Generator can use them to create valid C/C++ identifiers. If your FPGA VI name contains multi-byte characters, specify a custom prefix before generating the C API.

Note Note  You can use multi-byte characters in the captions of controls and indicators without affecting the generated C API.

Naming of Files and Constants

For example, if the original bitfile was compiled from an FPGA VI called My Temperature-Monitoring Application.vi, the generated .lvbitx file would by default be named NiFpga_MyTemperatureMonitoringApplication.lvbitx.

The FPGA Interface C API Generator uses the VI name or custom prefix, the data type, and the label or name of each control, indicator, and FIFO in the FPGA VI, to create the names of each constant in the .h file.

The FPGA Interface C API Generator removes all characters except alphanumeric characters and underscores from the label of the control or indicator, or from the name of the FIFO, before using the label or name in the name of the constant. The following example is the name of a constant corresponding to a Boolean indicator called Max Temp Exceeded in the FPGA VI described above.

NiFpga_MyTemperatureMonitoringApplication_IndicatorBool_MaxTempExceeded

WAS THIS ARTICLE HELPFUL?

Not Helpful