Difference between revisions of "Pcall"
m (Text replacement - "</source>" to "</syntaxhighlight>") |
|||
| Line 23: | Line 23: | ||
=== Example === | === Example === | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| + | local bmp | ||
local spath = "gfx/myimage.jpj" -- notice the error jpj instead of jpg | local spath = "gfx/myimage.jpj" -- notice the error jpj instead of jpg | ||
local result, value = pcall(Texture.new, spath) | local result, value = pcall(Texture.new, spath) | ||
| − | print(result, value) -- false, nil | + | if result then |
| + | bmp = Bitmap.new(value) -- we use the value | ||
| + | else | ||
| + | print(result, value) -- false, nil | ||
| + | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 11:37, 5 October 2023
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.
(bool), (any) = pcall(f,arg1,arg2,...)
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.
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
Example
local bmp
local spath = "gfx/myimage.jpj" -- notice the error jpj instead of jpg
local result, value = pcall(Texture.new, spath)
if result then
bmp = Bitmap.new(value) -- we use the value
else
print(result, value) -- false, nil
end
See Also
