IDL

N_PARAMS

N_PARAMS

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

Notes


This page has no user notes yet. Be the first one!


This information is not subject to the controls of the International Traffic in Arms Regulations (ITAR) or the Export Administration Regulations (EAR). However, it may be restricted from transfer to various embargoed countries under U.S. laws and regulations.
© 2014 Exelis Visual Information Solutions