params

returns all the parameters pass to the current handler.

# Metadata

Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:

# Syntax

the params

# Examples

the params

put char 2 to -2 of word 1 of the params into handlerName

# Description

Use the params function within a handler to get the parameters that were pass to the handler.

Usually, you assign names to parameters in the first line of a function handler or message handler. For example, the following handler assigns three parameters:

on myHandler thisParam,thatParam,theOtherParam answer thisParam & return & thatParam & return & theOtherParam end myHandler

If you call the above handler with four parameters, the first three parameters are assigned to the names thisParam, thatParam, and theOtherParam, but the fourth parameter is not assigned a name:

myHandler "red","green","blue","yellow"

You can obtain the fourth parameter for use in the handler with the params function :

on myHandler thisParam,thatParam,theOtherParam put item 4 of the params into yetAnotherParam answer yetAnotherParam end myHandler

In this case, item 4 of the params is "yellow". (To use the value itself, you need to remove the opening and closing quotes.)

If the params function is used in a function handler, the parameters are enclosed in parentheses. For example, the following function handler has three parameters:

function myFunction thisParam,thatParam,theOtherParam return thisParam & return & thatParam & return & theOtherParam end myFunction

If you call "myFunction" with the following statement:

get myFunction("red","green","blue")

the value returned by the params function is

"myFunction("red","green","blue")".

LiveCode evaluates the parameters before passing them. So if you call myHandler with the following statement:

myHandler 1+1,"A","Hello" && "world"

the value returned by the params function is

myHandler "2","A","Hello world"

# Tags

properties,

# See

- **command:** call - **function:** paramCount - **control structure:** function - **glossary:** pass, handler, parameter, function handler, return, value