WoW:API GetNumWhoResults: Difference between revisions

Decided that FrameXML is wrong and I'm right =)
No edit summary
(Decided that FrameXML is wrong and I'm right =))
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}}
Anonymous user