WoW:API GetNumWhoResults - Revision history

Bear at 07:14, 15 August 2023

2023-08-15T07:14:59Z

← Older revision		Revision as of 07:14, 15 August 2023
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__


	Get the number of entries resulting from your most recent /who query.		Get the number of entries resulting from your most recent /who query.
	numWhos, totalCount = GetNumWhoResults();		numWhos, totalCount = GetNumWhoResults();


	== Arguments ==		== Arguments ==
	:None		:None


	== Returns ==		== Returns ==
Line 15:		Line 12:
	:;totalCount : Number - number of users matching the query		:;totalCount : Number - number of users matching the query
	:;numWhos : Number - number of entries actually returned		:;numWhos : Number - number of entries actually returned


	== Details ==		== Details ==
	: This function only returns the last /who query results after the "[[Events/W#WHO_LIST_UPDATE\|WHO_LIST_UPDATE]]" event has fired.		: This function only returns the last /who query results after the "[[Events/W#WHO_LIST_UPDATE\|WHO_LIST_UPDATE]]" event has fired.

2023-08-15T04:46:17Z

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

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

2007-06-21T17:34:45Z

Revised for clarity and to match the current boilerplate. Moved comments to the talk page and added timestamps.

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}} __NOTOC__
-<center>'''Title''' ''-Documentation by [[user:Mikk|Mikk]]-''</center>
 Get the number of entries resulting from your most recent /who query.
-== Parameters ==
+== Returns ==
 :totalCount, numWhos
@@ Line 15: / Line 16: @@
 :;numWhos : Number - number of entries actually returned
-After you call [[API SendWho|SendWho]]("filter"); you have to wait for a WHO_LIST_UPDATE [[Events %28API%29 | event]] before the results are available. So you'll need to call [[API GetNumWhoResults|GetNumWhoResults]](); from an [[Events %28API%29 | event]] handler.
+== Details ==

2007-06-21T13:01:04Z

Returns

← Older revision		Revision as of 13:01, 21 June 2007
Line 33:		Line 33:
	local numWhos, totalCount = GetNumWhoResults();		local numWhos, totalCount = GetNumWhoResults();
	DEFAULT_CHAT_FRAME:AddMessage('numWhos = '..tostring(numWhos).. ' totalCount = '..tostring(totalCount));		DEFAULT_CHAT_FRAME:AddMessage('numWhos = '..tostring(numWhos).. ' totalCount = '..tostring(totalCount));

			----
			__NOTOC__

			Comment by [[user:hudlee\|hudlee]]

			After you call [[API SendWho\|SendWho]]("filter"); you have to wait for a WHO_LIST_UPDATE [[Events %28API%29 \| event]] before the results are available. So you'll need to call [[API GetNumWhoResults\|GetNumWhoResults]](); from an [[Events %28API%29 \| event]] handler.

2007-03-06T20:08:06Z

← Older revision		Revision as of 20:08, 6 March 2007
Line 25:		Line 25:
	----		----
	__NOTOC__		__NOTOC__

			Comment by [[user:egingell\|egingell]]

			The following code does not produce the results I expected. First pass (assume that it should find 10 people) sends 'numWhos = 0 totalCount = 0' to the chat frame. Second pass (assume that it should find 1 person) sends 'numWhos = 10 totalCount = 10' to the chat frame. Third pass sends 'numWhos = 1 totalCount = 1' to the chat frame. GetNumWhoResults() seems to be one step behind [[API SendWho\|SendWho]]().

			SendWho(filter);
			local numWhos, totalCount = GetNumWhoResults();
			DEFAULT_CHAT_FRAME:AddMessage('numWhos = '..tostring(numWhos).. ' totalCount = '..tostring(totalCount));

2007-02-10T06:20:13Z

Remove singatures made using ~ in main namespace

← Older revision		Revision as of 06:20, 10 February 2007
Line 20:		Line 20:


	''FrameXML has these two names swapped around, but I suspect that it is a bug. There is code to display a warning about the list being truncated, but it never triggers. ~~-- [[User:Mikk\|Mikk]] 15:47, 16 May 2006 (EDT)~~''		''FrameXML has these two names swapped around, but I suspect that it is a bug. There is code to display a warning about the list being truncated, but it never triggers.''


	----		----
	__NOTOC__		__NOTOC__

2007-01-06T18:11:55Z

upgraded deprecated template

← Older revision		Revision as of 18:11, 6 January 2007
Line 1:		Line 1:
			{{wowapi}}
	<center>'''Title''' ''-Documentation by [[user:Mikk\|Mikk]]-''</center>		<center>'''Title''' ''-Documentation by [[user:Mikk\|Mikk]]-''</center>

Line 24:		Line 25:
	----		----
	__NOTOC__		__NOTOC__
	~~{{Template:WoW API}}~~

2006-05-16T19:47:14Z

Decided that FrameXML is wrong and I'm right =)

← Older revision		Revision as of 19:47, 16 May 2006
Line 1:		Line 1:
	~~Returns the number of current entries on your Who~~-~~List.~~		<center>'''Title''' ''-Documentation by [[user:Mikk\|Mikk]]-''</center>

	{{~~template~~:WoW API}}		Get the number of entries resulting from your most recent /who query.

			<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
			numWhos, totalCount = GetNumWhoResults();

			== Parameters ==
			=== Returns ===
			;''Returns''
			:totalCount, numWhos

			:;totalCount : Number - number of users matching the query
			:;numWhos : Number - number of entries actually returned

			Normally, these two will be returned as the same number.

			However, if the query matched more players than the server wants to return (currently 49), totalCount will be returned as 50 and numWhos will be returned as 49. Hence, totalCount being greater than numWhos seems to be a future-safe indication of the list having been truncated.


			''FrameXML has these two names swapped around, but I suspect that it is a bug. There is code to display a warning about the list being truncated, but it never triggers. -- [[User:Mikk\|Mikk]] 15:47, 16 May 2006 (EDT)''


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

2005-12-30T19:44:32Z

← Older revision		Revision as of 19:44, 30 December 2005
Line 1:		Line 1:
	Returns the number of current entries on your Who-List.		Returns the number of current entries on your Who-List.

			{{template:WoW API}}

2005-08-28T17:47:11Z

New page

Returns the number of current entries on your Who-List.