Difference between revisions of "Pcall"
| Line 3: | Line 3: | ||
'''<translate>Available since</translate>:''' Gideros 2011.6<br/> | '''<translate>Available since</translate>:''' Gideros 2011.6<br/> | ||
'''<translate>Class</translate>:''' [[Special:MyLanguage/(global)|(global)]]<br/> | '''<translate>Class</translate>:''' [[Special:MyLanguage/(global)|(global)]]<br/> | ||
| + | |||
=== <translate>Description</translate> === | === <translate>Description</translate> === | ||
<translate>Calls function f with the given arguments in protected mode. This means that any error inside f is not propagated; instead, [[Special:MyLanguage/pcall|pcall]] catches the error and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, [[Special:MyLanguage/pcall|pcall]] also returns all results from the call, after this first result. In case of any error, [[Special:MyLanguage/pcall|pcall]] returns false plus the error message.</translate> | <translate>Calls function f with the given arguments in protected mode. This means that any error inside f is not propagated; instead, [[Special:MyLanguage/pcall|pcall]] catches the error and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, [[Special:MyLanguage/pcall|pcall]] also returns all results from the call, after this first result. In case of any error, [[Special:MyLanguage/pcall|pcall]] returns false plus the error message.</translate> | ||
| Line 8: | Line 9: | ||
(bool), (any) = pcall(f,arg1,arg2,...) | (bool), (any) = pcall(f,arg1,arg2,...) | ||
</source> | </source> | ||
| + | |||
=== <translate>Parameters</translate> === | === <translate>Parameters</translate> === | ||
'''f''': (function) <translate>function to call in protected mode</translate> <br/> | '''f''': (function) <translate>function to call in protected mode</translate> <br/> | ||
| Line 13: | Line 15: | ||
'''arg2''': (any) <translate>argument to pass to the function</translate> '''optional'''<br/> | '''arg2''': (any) <translate>argument to pass to the function</translate> '''optional'''<br/> | ||
'''...''': (any) <translate>other optional arguments</translate> '''optional'''<br/> | '''...''': (any) <translate>other optional arguments</translate> '''optional'''<br/> | ||
| + | |||
=== <translate>Return values</translate> === | === <translate>Return values</translate> === | ||
'''<translate>Returns</translate>''' (bool) <translate>false if there was error, true if function call succeeded</translate><br/> | '''<translate>Returns</translate>''' (bool) <translate>false if there was error, true if function call succeeded</translate><br/> | ||
'''<translate>Returns</translate>''' (any) <translate>all the results that function returns</translate><br/> | '''<translate>Returns</translate>''' (any) <translate>all the results that function returns</translate><br/> | ||
| + | |||
| + | {{(global)}} | ||
Revision as of 05:16, 11 February 2020
Available since: Gideros 2011.6
Class: (global)
Description
Calls function f with the given arguments in protected mode. This means that any error inside f is not propagated; instead, pcall catches the error and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, pcall also returns all results from the call, after this first result. In case of any error, pcall returns false plus the error message.
(bool), (any) = pcall(f,arg1,arg2,...)
Parameters
f: (function) function to call in protected mode
arg1: (any) argument to pass to the function optional
arg2: (any) argument to pass to the function optional
...: (any) other optional arguments optional
Return values
Returns (bool) false if there was error, true if function call succeeded
Returns (any) all the results that function returns
