Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

help (MathScript RT Module Function)

LabVIEW 2011 MathScript RT Module Help

Edition Date: June 2011

Part Number: 373123B-01

»View Product Info

Owning Class: support

Requires: MathScript RT Module

Syntax

help

help browser

help class

help classes

help function

help partial name of function or class

help product

help product class

help product function

Description

Provides help for a specific topic in the LabVIEW MathScript Window. help and help browser provide an overview of the LabVIEW MathScript Window. help class provides a list of the names and short descriptions of all functions in a particular class. If the name of the class contains two or more words, you must use an underscore (_) between each word. help classes provides a list of all classes of functions and topics as well as a short description of each class. help function provides reference help for a particular function or topic, including its name, syntax, description, inputs and outputs, examples to type in the Command Window, and related functions or topics. help partial name of function or class provides a list of all MathScript functions and classes that begin with the letters you type.

If you define a function with the same name as a built-in LabVIEW MathScript function, help function returns help content only for the function you defined. You cannot retrieve the help content for the original MathScript function. To revert to the original MathScript function, either delete the function you defined, rename the function you defined to a name that is different from the built-in MathScript function, or use the MathScript page of the Options dialog box or the MathScript: Search Paths page of the LabVIEW MathScript Properties dialog box to remove the path that contains the function you defined. After you remove the path, LabVIEW no longer loads the function you defined into memory because the list LabVIEW searches does not include the path to the function.

LabVIEW modules and toolkits you have installed might provide additional LabVIEW MathScript functions. Type help product to display a list of all classes of functions that a LabVIEW module or toolkit adds. For example, type help cdsim to access a list of all classes of functions installed with the LabVIEW Control Design and Simulation Module. Type help product class or help product function to access help for a particular class of functions or a particular function that product adds, respectively. If the class or function name does not conflict with another name in LabVIEW MathScript, you also can type help class or help function to access help for that class or function, respectively.
If you define a function with the same name as a MathScript function that a LabVIEW module or toolkit adds, help function returns help content for the function you defined and lists the functions of the same name that the module or toolkit adds.

Details

Examples

Details

By default, the help command displays help in an HTML Help window. To display help in the Output Window of the LabVIEW MathScript Window, remove the checkmark from the Display HTML Help? checkbox on the MathScript: Window Options page of the LabVIEW MathScript Properties dialog box. If you define a function, LabVIEW always displays the help for the function you defined in the Output Window.

The following table lists the support characteristics of this function.

Supported in the LabVIEW Run-Time Engine No (always ignored)
Supported on RT targets No

Examples

help svd

help filter_design

help pro


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit