commandArguments

Type

function

Summary

If no index is given, returns a 1-based, numeric array containing all the arguments given to the command. If an index is given, returns the argument corresponding to the index (1 being the first argument).

Syntax

the commandArguments

commandArguments(<index>)

the commandArguments of <index>

Description

Returns a 1-based numeric array containing the commandline arguments

With no index given, the commandArguments function returns an 1-based, numeric array containing the arguments given at the launch of the application. With an index given, it returns the commandline argument at this index The list only exists on desktop standalones applications and server scripts. On mobile platform or in the IDE, the commandArguments returns empty.

Parameters

Name	Type	Description
index	integer	An integer greater than 0. If the index is greater than the number of arguments, then commandArguments returns empty.

Examples

local tArgs
put the commandArguments into tArgs
put the keys of tArgs

repeat for each element tArgument in the commandArguments
    if tArgument is "-v" then
       put true into tVerbose
    end if
end repeat

put commandArguments(1)

Value

Name	Type	Description
return		Returns either a numeric array with all the commandline arguments if no index is given, or the argument at the index specified.

Related

keyword: dollar

Compatibility and Support

Introduced

LiveCode 7.1.0

OS

mac

windows

linux

Platforms

desktop

server