WshArguments Object

 

Provides access to the entire collection of command-line parameters — in the order in which they were originally entered.

Remarks

The WshArguments object is a collection returned by the WScript object's Arguments property (WScript.Arguments). Two of the WshArguments object's properties are filtered collections of arguments — one contains the named arguments (querying this property returns a WshNamed object), the other contains the unnamed arguments (querying this property returns a WshUnnamed object). There are three ways to access sets of command-line arguments.

• You can access the entire set of arguments (those with and without names) with the WshArguments object.

• You can access the arguments that have names with the WshNamed object.

• You can access the arguments that have no names with the WshUnnamed object.

Legacy Code Example

The following code displays the command-line parameters in the WshArguments object. Note that you can get individual arguments by calling either WScript.Arguments.Item(i) or WScript.Arguments(i).

Set objArgs = WScript.Arguments
For i = 0 to objArgs.Count - 1
   WScript.Echo objArgs(i)
Next

objArgs = WScript.Arguments;
for (i = 0; i < objArgs.length; i++)
{
   WScript.Echo(objArgs(i));
}

Properties

Item Property | Length Property | Named Property | Unnamed Property

Methods

Count Method | ShowUsage Method

See Also

Arguments Property (WScript Object)
WshNamed Object
WshUnnamed Object