Build Hook VIs (Advanced Build Parameters)

The Build Hook VIs page of the Advanced Build Parameters dialog, shown below, allows you to specify the paths to build hook VIs, which are executed during the build process.

Figure 60 - Build Hook VIs page of the Advanced Build Parameters dialog

These VIs are called during the package build process and run inside the LabVIEW development system (the same LabVIEW version used to build the package). These allow you to extend the capabilities of the VI Package building process.

Build Hook VI Requirements

•      Build Hook VIs must be compatible with the same version of LabVIEW that is used to build the package.

•      In order to receive parameters from VIPM, the build hook VI should have a variant control on its Front Panel named "Variant".

•      In order to pass error information to VIPM, the build hook VI should have an error out indicator on its Front Panel named "error out".

Build Hook VI Example

The following example, demonstrates a simple build hook VI:

Figure 61 - Example Build Hook Front Panel

Figure 62 - Example Build Hook Block Diagram

Build Hook Parameters
In order to receive parameters from VIPM, a build hook VI should have a variant control on its Front Panel named "Variant". Parameters are passed via variant attributes.

The names and data types of these attributes are as follows:

Pre Build Hook Parameters

Name: Package Source Folder
Type: path
Description: The (absolute) path of the VI Package Source Folder.

Name: Package Member Source Files
Type: array of paths
Description: A 1D array of (absolute) paths of the package member source files.

Post Build Hook Parameters

Name: Output Package File Path
Type: path
Description: The (absolute) path of the output package file being built.

Modifying Packages
Build hook VIs can modify packages, but they may not add or remove VIs, CTL, or other LabVIEW files from the package.

If you have any feedback or questions (including ideas for other topics you'd like to learn more about), please consider posting them to the VIPM Discussion Forums.  We're looking forward to your feedback. All Contents, Copyright © 2006-2009, JKI. All Rights Reserved.