Previous IDL Reference Guide: Procedures and Functions Next

N_PARAMS

Syntax | Return Value | Arguments | Keywords | Version History | See Also

The N_PARAMS function returns the number of parameters used in calling an IDL procedure or function. This function is only useful within IDL procedures or functions. User-written procedures and functions can use N_PARAMS to determine if they were called with optional parameters.


Note
In the case of object method procedures and functions, the SELF argument is not counted by N_PARAMS.

Syntax

Result = N_PARAMS()

Return Value

Returns the number of non-keyword parameters.

Arguments

None. This function always returns the number of parameters that were used in calling the procedure or function from which N_PARAMS is called.

Keywords

None.

Version History

Original
Introduced

See Also

KEYWORD_SET

  IDL Online Help (March 06, 2007)