param

Calc Software Package for Number Calc

NAME
    param - value of argument in a user-function call

SYNOPSIS
    param([n])

TYPES
    n		nonnegative integer

    return	any

DESCRIPTION
    The function param(n) can be used only within the body of the
    definition of a function.

    If that function is f()

	[[ which may have been defined with named arguments as in f(x,y,z))

    and either the number of arguments or the value of an argument
    in an anticipated call to f() is to be used, the number of
    arguments in that call will then be returned by:

	param(0)

    and the value of the n-th argument by:

	param(n)

    Note that unlike the argv() builtin, param(1) is the 1st parameter
    and param(param(0) is the last.

EXAMPLE
    ; define f() {
    ;;	local n, v = 0;
    ;;	for (n = 1; n <= param(0); n++)
    ;;		v += param(n)^2;
    ;;	return v;
    ;; }

    ; print f(), f(1), f(1,2), f(1,2,3)
    0 1 5 14

LIMITS
    none

LINK LIBRARY
    none

SEE ALSO
    argv, command

## Copyright (C) 1999-2006  Landon Curt Noll
##
## Calc is open software; you can redistribute it and/or modify it under
## the terms of the version 2.1 of the GNU Lesser General Public License
## as published by the Free Software Foundation.
##
## Calc is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
## or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU Lesser General
## Public License for more details.
##
## A copy of version 2.1 of the GNU Lesser General Public License is
## distributed with calc under the filename COPYING-LGPL.  You should have
## received a copy with calc; if not, write to Free Software Foundation, Inc.
## 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
##
## @(#) $Revision: 29.4 $
## @(#) $Id: param,v 29.4 2006/06/10 12:28:10 chongo Exp $
## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/param,v $
##
## Under source code control:	1996/03/12 23:10:01
## File existed as early as:	1996
##
## chongo <was here> /\oo/\	http://www.isthe.com/chongo/
## Share and enjoy!  :-)	http://www.isthe.com/chongo/tech/comp/calc/