arguments Object (Windows Scripting - JScript)

 

An object representing the arguments to the currently executing function, and the functions that called it.

Syntax

[function.]arguments[n]

Arguments

• function
  Optional. The name of the currently executing Function object.

• n
  Required. The zero-based index to argument values passed to the Function object.

Remarks

You cannot explicitly create an arguments object. The arguments object only becomes available when a function begins execution. The arguments object of the function is not an array, but the individual arguments are accessed the same way array elements are accessed. The index n is actually a reference to one of the 0n properties of the arguments object.

The following example illustrates the use of the arguments object.

function ArgTest(a, b)
{
   var s = "";

   s += "Expected Arguments: " + ArgTest.length;
   s += "<br />";
   s += "Passed Arguments: " + arguments.length;
   s += "<br />";

   s += "The individual arguments are: "
   for (n = 0; n < arguments.length; n++)
   {
      s += ArgTest.arguments[n];
      s += " ";
   }

   document.write(s);
}

ArgTest(1, 2, "hello", new Date())

Requirements

Version 1

Change History

Date	History	Reason
March 2009	Modified example.	Information enhancement.

See Also

0...n Properties (Windows Scripting - JScript)
callee Property (Windows Scripting - JScript)
length Property (arguments) (Windows Scripting - JScript)