Define VI Prototype Dialog Box

LabVIEW 2018 Help


Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2015 Help
LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help

Requires: Professional System

From the Source Files page of the Shared Library Properties dialog box, select a VI in the Exported VIs listbox and click the Define Prototype button to display this dialog box. The dialog box also displays automatically when you move a VI to the Exported VIs listbox.

Use this dialog box to define the parameters of an exported VI for a shared library.

This dialog box includes the following components:

  • Function Name—Defines the name of the function in the shared library.
  • Standard Calling Conventions—Sets the function prototype to use standard calling conventions.
  • C Calling Conventions—Sets the function prototype to use C calling conventions. This radio button is enabled by default.
  • Parameters—Lists the current parameters for the VI prototype. You can configure the Parameters list using the following buttons along the right side of the Parameters list. return value is a required parameter that you cannot delete.
    Note  If you want to include a control or indicator as a parameter, you must use the connector pane of the VI to configure it as an input or output.
    • Add—Adds a parameter from the controls and indicators of the VI. If you did not set up the connector pane for the VI, the Add button is dimmed.
    • Delete the selected parameter—Deletes the selected parameter from the Parameters list.
    • Move the selected parameter up one—Moves the selected parameter up one level in the Parameters list, which modifies the order of the parameters in the function prototype.
    • Move the selected parameter down one—Moves the selected parameter down one level in the Parameters list, which modifies the order of the parameters in the function prototype.
  • Current Parameter—Allows you to configure the settings for the selected parameter. Available settings differ depending on the type of parameter. LabVIEW provides only valid settings for each parameter.
    • Name—Specifies the name of the selected parameter.
    • Param Type—Specifies whether the selected parameter type is input, output, or input/output.
    • VI Input—Associates an input of the VI with the current parameter.
    • VI Output—Associates an output of the VI with the current parameter.
    • Pass By—Specifies the method the parameter uses to send data.
    • Length Input—Specifies the length of the input either as a specific value, the number of items in the array, or as another parameter in the Parameters listbox.
    • Length Output—Specifies the length of the output either as a specific value, the number of items in the array, or as another parameter in the Parameters listbox.
  • Function Prototype—Displays the code generated using the current settings for the function prototype. You cannot edit the code directly in this field.
  • Custom Documentation—Specifies whether to enable the Documentation text box so you can edit the function documentation.
  • Documentation—Specifies the text to use for the function documentation that appears above the function prototype in the generated header file. By default, LabVIEW generates this text from the VI description. LabVIEW does not export VI parameter descriptions to the generated function documentation.

WAS THIS ARTICLE HELPFUL?

Not Helpful