WoW:API GetNumWhoResults: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
No edit summary
 
(3 intermediate revisions by 3 users not shown)
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.
Get the number of entries resulting from your most recent /who query.
  numWhos, totalCount = GetNumWhoResults();


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


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


Line 15: Line 13:
:;numWhos : Number - number of entries actually returned
:;numWhos : Number - number of entries actually returned


Normally, these two will be returned as the same number.
== Details ==
 
: This function only returns the last /who query results after the "[[Events/W#WHO_LIST_UPDATE|WHO_LIST_UPDATE]]" event has fired.
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.''
 
 
----
__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));

Latest revision as of 07:14, 15 August 2023

← WoW API < GetNumWhoResults

Get the number of entries resulting from your most recent /who query. 

  numWhos, totalCount = GetNumWhoResults();

Arguments[edit]

None

Returns[edit]

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

Details[edit]

This function only returns the last /who query results after the "WHO_LIST_UPDATE" event has fired.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetNumWhoResults&oldid=20972"