WoW:API pcall: Difference between revisions

1 byte removed ,  19 September 2013
m
no edit summary
({{luaapi}})
mNo edit summary
Line 1: Line 1:
{{luaapi}}
{{wowlua}}
Calls a function, returning a boolean indicating success as the first return value, and error text / return values as the following values.
Calls a function, returning a boolean indicating success as the first return value, and error text / return values as the following values.
  retOK, ret1, ret2, ... retn = pcall (func, arg1, arg2, ...);
  retOK, ret1, ret2, ... retn = pcall (func, arg1, arg2, ...);


== Arguments ==
== Arguments ==
;func : Function - The function that will be called (from within) pcall().
;func
;arg1 - argn : Variable - Any variable that is also to be passed with the function when its called (Optional).
: Function - The function that will be called (from within) pcall().
;arg1 - argn
: Variable - Any variable that is also to be passed with the function when its called (Optional).


== Returns ==
== Returns ==
;retOK : Boolean - If the call to the function (that was passed to pcall) succeeded, returns true. If an error occured, returns false.
;retOK
;ret1 : String (if failed) / Variable - If an error occured, error text is returned; if not, ret1 is the first return value of the original function.
: Boolean - If the call to the function (that was passed to pcall) succeeded, returns true. If an error occured, returns false.
;ret2 - retn : Variable - If the function call succeeded, those return variables contain values returned by original function.
;ret1
: String (if failed) / Variable - If an error occured, error text is returned; if not, ret1 is the first return value of the original function.
;ret2 - retn
: Variable - If the function call succeeded, those return variables contain values returned by original function.


== Example ==
== Example ==