WoW:API pcall - Revision history

Bear at 21:17, 2 August 2025

2025-08-02T21:17:49Z

← Older revision		Revision as of 21:17, 2 August 2025
Line 18:		Line 18:

	== Example ==		== Example ==
	function myTest(incrementVal)		<pre>
	return incrementVal + 10;		function myTest(incrementVal)
	end		return incrementVal + 10;
			end

	local retOK, ret1 = pcall(myTest,"string value");		local retOK, ret1 = pcall(myTest,"string value");
	local msg = "";		local msg = "";
	if (retOK) then		if retOK then
	msg = "Function succeeded, result: " .. ret1 .. ".";		msg = "Function succeeded, result: " .. ret1 .. ".";
	else		else
	msg = "Function failed, error text: " .. ret1 .. ".";		msg = "Function failed, error text: " .. ret1 .. ".";
	end		end
	DEFAULT_CHAT_FRAME:AddMessage(msg);		DEFAULT_CHAT_FRAME:AddMessage(msg);
			</pre>

	====Result====		==== Result ====
	pcall will catch the error that ~~occured~~ within 'myTest', and output the appropriate text to the default chat window. If "string value" is replaced by a number, the code will output number+10 instead.		'pcall' will catch the error that occurred within 'myTest', and output the appropriate text to the default chat window. If "string value" is replaced by a number, the code will output number+10 instead.

	==Details==		==Details==
	: pcall will ''also'' return other arguments returned from the "function" if all is successful.		: pcall will ''also'' return other arguments returned from the "function" if all is successful.

Move page script: Move page script moved page API pcall to WoW:API pcall without leaving a redirect

2023-08-15T04:47:00Z

Move page script moved page API pcall to API pcall without leaving a redirect

← Older revision

Revision as of 04:47, 15 August 2023

Bear at 07:32, 19 September 2013

2013-09-19T07:32:29Z

← Older revision		Revision as of 07:32, 19 September 2013
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 ==

WoWWiki>Starlightblunder: {{luaapi}}

2010-03-25T23:03:11Z

← Older revision		Revision as of 23:03, 25 March 2010
Line 1:		Line 1:
	~~<center>'''~~pcall~~''' ''-Documentation by [[user:Darjk\|Darjk]]-''</center>~~		{{luaapi}}
			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, ...);

	~~Native Lua statement~~:		== Arguments ==
			;func : 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 a boolean value to catch errors from the function call (func).~~		== Returns ==
			;retOK : Boolean - If the call to the function (that was passed to pcall) succeeded, returns true. If an error occured, returns false.
	~~retVal = pcall (func, arg1, arg2, ...);~~		;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.
	~~== Parameters ==~~
	~~=== Arguments ===~~
	~~:(func, arg1, arg2, ...)~~

	~~:;func : Function - The function that will be called (from within) pcall().~~
	~~:;arg1 : Variable - Any variable that is also to be passed with the function when its called (if any).~~
	~~:;arg2 : Variable - Same as arg1.~~

	=== Returns ===
	;~~''Returns''~~

	~~:retVal~~

	~~:;retvaL~~ : Boolean - If the call to the function (that was passed to pcall) succeeded, returns true. If an error occured, returns false.

	== Example ==		== Example ==
	function myTest()		function myTest(incrementVal)
	~~local strTest = "I am a string";~~		return incrementVal + 10;
	~~strTest = strTest~~ + 10;
	end		end

	local ~~retVal~~ = pcall(myTest);		local retOK, ret1 = pcall(myTest,"string value");
			local msg = "";
			if (retOK) then
			msg = "Function succeeded, result: " .. ret1 .. ".";
			else
			msg = "Function failed, error text: " .. ret1 .. ".";
			end
			DEFAULT_CHAT_FRAME:AddMessage(msg);

	====Result====		====Result====
	pcall will catch the error that occured within 'myTest' and ~~return false~~.		pcall will catch the error that occured within 'myTest', and output the appropriate text to the default chat window. If "string value" is replaced by a number, the code will output number+10 instead.
	~~retVal = false;~~

	==Details==		==Details==
	: pcall will ''also'' return other arguments returned from the "function" if all is successful.		: pcall will ''also'' return other arguments returned from the "function" if all is successful.

	~~{{LUA}}~~

WoWWiki>Mikk: Change category from "LUA Functions" to "Lua functions".

2006-05-26T12:15:33Z

Change category from "LUA Functions" to "Lua functions".

← Older revision		Revision as of 12:15, 26 May 2006
Line 1:		Line 1:
	<center>'''pcall''' ''-Documentation by [[user:Darjk\|Darjk]]-''</center>		<center>'''pcall''' ''-Documentation by [[user:Darjk\|Darjk]]-''</center>

			Native Lua statement:

	Returns a boolean value to catch errors from the function call (func).		Returns a boolean value to catch errors from the function call (func).
Line 35:		Line 37:
	: pcall will ''also'' return other arguments returned from the "function" if all is successful.		: pcall will ''also'' return other arguments returned from the "function" if all is successful.

	~~----~~		{{LUA}}
	~~__NOTOC__~~
	{{~~Template:WoW API~~}}

WoWWiki>Lje: /* Example */

2006-04-18T15:36:49Z

Example

← Older revision		Revision as of 15:36, 18 April 2006
Line 26:		Line 26:
	end		end

	local retVal = pcall(myTest());		local retVal = pcall(myTest);

	====Result====		====Result====

WoWWiki>Anticrash at 15:04, 4 January 2006

2006-01-04T15:04:07Z

← Older revision		Revision as of 15:04, 4 January 2006
Line 38:		Line 38:
	__NOTOC__		__NOTOC__
	{{Template:WoW API}}		{{Template:WoW API}}
	~~[[Category:API Functions\|pcall]]~~
	~~[[Category:API LUA Functions\|pcall]]~~

WoWWiki>Inglais at 18:41, 29 August 2005

2005-08-29T18:41:58Z

← Older revision		Revision as of 18:41, 29 August 2005
Line 38:		Line 38:
	__NOTOC__		__NOTOC__
	{{Template:WoW API}}		{{Template:WoW API}}
			[[Category:API Functions\|pcall]]
	[[Category:API LUA Functions\|pcall]]		[[Category:API LUA Functions\|pcall]]

WoWWiki>Darjk at 04:51, 25 August 2005

2005-08-25T04:51:26Z

New page

<center>'''pcall''' ''-Documentation by [[user:Darjk|Darjk]]-''</center>

Returns a boolean value to catch errors from the function call (func).

retVal = pcall (func, arg1, arg2, ...);

== Parameters ==
=== Arguments ===
:(func, arg1, arg2, ...)

:;func : Function - The function that will be called (from within) pcall().
:;arg1 : Variable - Any variable that is also to be passed with the function when its called (if any).
:;arg2 : Variable - Same as arg1.

=== Returns ===
;''Returns''

:retVal

:;retvaL : Boolean - If the call to the function (that was passed to pcall) succeeded, returns true. If an error occured, returns false.

== Example ==
function myTest()
local strTest = "I am a string";
strTest = strTest + 10;
end

local retVal = pcall(myTest());

====Result====
pcall will catch the error that occured within 'myTest' and return false.
retVal = false;

==Details==
: pcall will ''also'' return other arguments returned from the "function" if all is successful.

----
__NOTOC__
{{Template:WoW API}}
[[Category:API LUA Functions|pcall]]