params

Typefunction
DictionaryLCS
LibraryLiveCode Script
Syntax
the params
params()
Summary

Returns all the parameters passed to the current handler.

Introduced1.0
Changes

The format of the params when used in a function handler was changed in version 2.0. In previous versions, the format for functions was the same as the format for message handlers: the parameters were not enclosed in parentheses, but instead separated from the handler name by a space.

OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Example
the params
put char 2 to -2 of word 1 of the params into handlerName
Values
NameTypeDescription
return

When used in a message handler, the params function returns the handler name, a space, and a list of parameter values, each enclosed in quotes and separated by commas. When used in a function handler, the params function returns the handler name, then the list of parameter values in parentheses. Each parameter value is enclosed in quotes and separated by commas.

RelatedCommand: call
Function: paramCount
Control Structure: function
Glossary: pass, handler, parameter, function handler, return, value
Description

Use the params function within a handler to get the parameters that were passed 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"

Tagsproperties