userpath (MathScript RT Module Function)
Owning Class: support
Requires: MathScript RT Module
Syntax
c = userpath
userpath(a)
userpath(flag)
Description
Returns the current search path list. LabVIEW searches the path list from top to bottom. If you define a function to use in the LabVIEW MathScript Window or in the MathScript Node, you must add the directory in which that function resides to the search path list.
userpath(a) changes the current path to a.
Inputs
| Name | Description | ||||
|---|---|---|---|---|---|
| a | Specifies the path you would like to set as the current search path. a is a string. | ||||
| flag | Specifies the operation performed on the search path. flag is a string that accepts the following values.
|
Outputs
| Name | Description |
|---|---|
| c | Returns the current user path. c is a string. |
Details
If you use this function in a stand-alone application or shared library, LabVIEW returns the path where you installed the application or shared library. (Real-Time Module) If you deploy this function to an RT target, LabVIEW returns the path given by the Default Data Directory VI.
Changes you make to the search path list using this function apply only to the current instance of the LabVIEW MathScript Window or the MathScript Node from which you call the function. Changes to the search path list for one MathScript Node do not apply to any other MathScript Nodes. LabVIEW resets the search path list to the default when you close the LabVIEW MathScript Window or when the MathScript Node stops executing. Use the MathScript: Search Paths page of the LabVIEW MathScript Properties dialog box to change the default search path list for the LabVIEW MathScript Window. Use the MathScript page of the Options dialog box to change the default search path list for MathScript Nodes in the main application instance.
If you call this function from a MathScript Node or a user-defined function, a warning glyph appears in the MathScript Node next to the line from which you call the function. The warning glyph indicates that LabVIEW operates with reduced error checking and slower run-time performance for the MathScript Node. To improve the error checking and optimize the performance of the MathScript Node, remove this function from scripts and user-defined functions. Also, do not change the MathScript search path list at run time. Instead, use the MathScript page to configure the default search path list for MathScript Nodes in the main application instance.
This function is not supported in the LabVIEW Run-Time Engine if you specify an input for the function. Either do not specify an input or remove these functions from your scripts before you build a stand-alone application or shared library.
Examples
userpath('C:\Program Files\National Instruments')