WoW:API issecurevariable - Revision history

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

2023-08-15T04:46:46Z

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

← Older revision	Revision as of 04:46, 15 August 2023
(No difference)

WoWWiki>Starlightblunder: second return value

2009-04-06T20:57:45Z

second return value

← Older revision		Revision as of 20:57, 6 April 2009
Line 2:		Line 2:
	Determines if given variable or table is [[secure]] or "[[Tainted (Addons)\|tainted]]." Any usage of a "[[Tainted (Addons)\|tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.		Determines if given variable or table is [[secure]] or "[[Tainted (Addons)\|tainted]]." Any usage of a "[[Tainted (Addons)\|tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.

	isSecure, ~~unknown~~ = issecurevariable([table], variable)		isSecure, taint = issecurevariable([table], variable)

	==~~Parameters==~~		==Returns==
	~~===Arguments=~~==		;isSecure : "boolean" flag: 1 if variable is secure, nil if it is tainted.
	:~~;[table], variable~~		;taint : string: addon that tainted the variable (possibly nil if not tainted by an addon).

	~~===Return===~~
	:~~;isSecure -~~ 1 (secure~~) or~~ nil ~~(not secure)~~
	:~~;unknown - always~~ nil~~. If isSecure is nil, this is~~ not ~~returned (implied nil~~).

	==Example 1==		==Example 1==
Line 35:		Line 31:
	end		end
	===Result===		===Result===
	*[[API_UnitName\|UnitName]] is not a protected Blizzard-defined function, but will still become tainted when hooked.		* [[API_UnitName\|UnitName]] is not a protected Blizzard-defined function, but will still become tainted when hooked.
	*Message "Given variable tainted. :s" will get displayed in your chat frame.		* Message "Given variable tainted. :s" will get displayed in your chat frame.

	==Notes==		==Notes==

WoWWiki>Egingell: I played around with this a little bit and this is what I got. :)

2009-01-30T06:24:10Z

I played around with this a little bit and this is what I got. :)

← Older revision		Revision as of 06:24, 30 January 2009
Line 2:		Line 2:
	Determines if given variable or table is [[secure]] or "[[Tainted (Addons)\|tainted]]." Any usage of a "[[Tainted (Addons)\|tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.		Determines if given variable or table is [[secure]] or "[[Tainted (Addons)\|tainted]]." Any usage of a "[[Tainted (Addons)\|tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.

	issecurevariable()		isSecure, unknown = issecurevariable([table], variable)

	==Parameters==		==Parameters==
Line 9:		Line 9:

	===Return===		===Return===
	:;~~nil~~ (~~tainted~~) or 1 (secure)		:;isSecure - 1 (secure) or nil (not secure)
			:;unknown - always nil. If isSecure is nil, this is not returned (implied nil).

	==Example 1==		==Example 1==
	local secure = issecurevariable( "JumpOrAscendStart" );		local secure = issecurevariable( "JumpOrAscendStart" );
	if ~~not (~~ secure ~~== nil )~~ then		if secure then
	DEFAULT_CHAT_FRAME:AddMessage("OK! Given variable is secure!");		DEFAULT_CHAT_FRAME:AddMessage("OK! Given variable is secure!");
	else		else
	DEFAULT_CHAT_FRAME:AddMessage("Given variable ~~is not secure, doing stuff with it will break secure status~~. :s");		DEFAULT_CHAT_FRAME:AddMessage("Given variable tainted. :s");
	end		end
	===Result===		===Result===
Line 23:		Line 24:

	==Example 2==		==Example 2==
	~~some_variable_not_defined_by_blizzard~~ = "~~bla39_j!~~";		local Old_UnitName = UnitName
	local secure = issecurevariable( "~~some_variable_not_defined_by_blizzard~~" );		function UnitName(unit)
	if ~~not (~~ secure ~~== nil )~~ then		return Old_UnitName(unit or "player")
			end
			local secure = issecurevariable( "UnitName" );
			if secure then
	DEFAULT_CHAT_FRAME:AddMessage("OK! Given variable is secure!");		DEFAULT_CHAT_FRAME:AddMessage("OK! Given variable is secure!");
	else		else
	DEFAULT_CHAT_FRAME:AddMessage("Given variable ~~is not secure, doing stuff with it will break secure status~~. :s");		DEFAULT_CHAT_FRAME:AddMessage("Given variable tainted. :s");
	end		end
	===Result===		===Result===
	*Message "Given variable ~~is not secure, doing stuff with it will break secure status~~. :s" will get displayed in your chat frame.		*[[API_UnitName\|UnitName]] is not a protected Blizzard-defined function, but will still become tainted when hooked.
			*Message "Given variable tainted. :s" will get displayed in your chat frame.

	==Notes==		==Notes==
	*~~Seems to always return~~ 1 for nil variables.		* Returns <code>1, nil</code> for undefined variables. This is because an undefined variable is secure since you have not tainted it.
			* Returns <code>1, nil</code> for all untainted variables (i.e. Blizzard variables).
			* Returns <code>nil</code> for '''any''' global variable that is hooked insecurely (tainted), even unprotected ones like [[API UnitName\|UnitName()]].
			* Returns <code>nil</code> for all user defined global variables.
			* If a table is passed first, it checks table.variable (e.g. <code>issecurevariable(PlayerFrame, "Show")</code> checks PlayerFrame["Show"] or PlayerFrame.Show (they are the same thing)).
			* Does not work for local variables.

WoWWiki>Tuhljin at 23:29, 14 May 2008

2008-05-14T23:29:22Z

← Older revision		Revision as of 23:29, 14 May 2008
Line 1:		Line 1:
	{{wowapi}}__NOTOC__		{{wowapi}}__NOTOC__
	Determines if given variable or table is [[secure]] or "[[Tainted (Addons)\|tainted]]". Any usage of a "[[Tainted (Addons)\|tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.		Determines if given variable or table is [[secure]] or "[[Tainted (Addons)\|tainted]]." Any usage of a "[[Tainted (Addons)\|tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.

	issecurevariable()		issecurevariable()

WoWWiki>Wachunga at 02:32, 12 April 2008

2008-04-12T02:32:17Z

← Older revision		Revision as of 02:32, 12 April 2008
Line 1:		Line 1:
	{{wowapi}}__NOTOC__		{{wowapi}}__NOTOC__
	~~Determinates~~ if given variable or table is [[secure]] or "[[Tainted (Addons)\|tainted]]". Any usage of a "[[Tainted (Addons)\|tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.		Determines if given variable or table is [[secure]] or "[[Tainted (Addons)\|tainted]]". Any usage of a "[[Tainted (Addons)\|tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.

	issecurevariable()		issecurevariable()

WoWWiki>Baudzilla at 00:46, 3 October 2007

2007-10-03T00:46:30Z

← Older revision		Revision as of 00:46, 3 October 2007
Line 1:		Line 1:
	{{wowapi}}__NOTOC__		{{wowapi}}__NOTOC__
	Determinates if given variable or table is [[secure]] or "[[tainted]]". Any usage of a "[[tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.		Determinates if given variable or table is [[secure]] or "[[Tainted (Addons)\|tainted]]". Any usage of a "[[Tainted (Addons)\|tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.

	issecurevariable()		issecurevariable()

WoWWiki>N3rf at 00:10, 4 January 2007

2007-01-04T00:10:00Z

New page

{{wowapi}}__NOTOC__
Determinates if given variable or table is [[secure]] or "[[tainted]]". Any usage of a "[[tainted]]" (= non-secure) variable, be it a function or simply data, will break [[secure]] state and prevent further access to Protected functions.

issecurevariable()

==Parameters==
===Arguments===
:;[table], variable

===Return===
:;nil (tainted) or 1 (secure)

==Example 1==
local secure = issecurevariable( "JumpOrAscendStart" );
if not ( secure == nil ) then
DEFAULT_CHAT_FRAME:AddMessage("OK! Given variable is secure!");
else
DEFAULT_CHAT_FRAME:AddMessage("Given variable is not secure, doing stuff with it will break secure status. :s");
end
===Result===
*[[API_JumpOrAscendStart|JumpOrAscendStart]] is a protected Blizzard-defined function, thus secure. Calling it will not break secure status.
*Message "OK! Given variable is secure!" will get displayed in your chat frame.

==Example 2==
some_variable_not_defined_by_blizzard = "bla39_j!";
local secure = issecurevariable( "some_variable_not_defined_by_blizzard" );
if not ( secure == nil ) then
DEFAULT_CHAT_FRAME:AddMessage("OK! Given variable is secure!");
else
DEFAULT_CHAT_FRAME:AddMessage("Given variable is not secure, doing stuff with it will break secure status. :s");
end
===Result===
*Message "Given variable is not secure, doing stuff with it will break secure status. :s" will get displayed in your chat frame.

==Notes==
*Seems to always return 1 for nil variables.