NParm
(Engine-Level Function)
Description: | Returns the number of parameters listed in a module instance. |
Returns: | Numeric |
Usage: | Script or steady state. |
Function Groups: | Compilation and On-Line Modifications, Advanced Module |
Related to: | AddParameter | FormalParms | NumParms | Parameter | RemoveParameter | ResetParm |
Format: | NParm(Object) |
Parameters: |
Object |
Required. Any object value, variable, or expression for a Module. |
Comments: | This function is for experienced users, and is not needed for normal operation. Any user-defined module can be called with any number of parameters. This function returns the actual number of parameters in the call made to the module instance Object. For launched modules the return value is the minimum of the actual and the formal parameters. |
Example:
< Show ( parm1; parm2; ) Main [ myParms = NParm(Self()); ] >
When called in steady-state as Show("A", "b", "C"), the value of myParms will be "3". When launched as Launch("Show", Invalid, Invalid, "A", "b", "C"), the value of myParms will be "2".