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

arginnum (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

c = arginnum

Legacy Name: nargin

Description

Returns the number of input arguments you supply to the function that calls arginnum. You can use arginnum to determine if the number of inputs you supply to a function is less than the maximum number of inputs for that function. You then can assign default values to define the optional inputs, or you can use the error function to return an appropriate error. If you attempt to call arginnum outside of a user-defined function, MathScript always returns 0.

Examples

Outputs

Name Description
c Returns the number of input arguments you supply to the function that calls arginnum. c is an integer.

Details

The following table lists the support characteristics of this function.

Supported in the LabVIEW Run-Time Engine Yes
Supported on RT targets Yes
Suitable for bounded execution times on RT Not characterized

Examples

Save the following script as integerdivision.m in the LabVIEW Data directory. The script uses arginnum to determine if the number of inputs you supply to integerdivision is less than 2. The script then assigns a default value of 1 to the divisor input.

function [quotient, remainder] = integerdivision(dividend, divisor)
%This is an example for using arginnum and argoutnum.
     if arginnum<2
          divisor = 1;
     end
quotient = floor(dividend / divisor);
     if argoutnum>1
          remainder = rem(dividend, divisor);
     end

After you save integerdivision.m, call the following commands in the LabVIEW MathScript Window or the MathScript Node.

[x, y] = integerdivision(14, 3)
[x, y] = integerdivision(14)

Related Topics

argoutnum


 

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