WoW:API GetNumWhoResults: Difference between revisions
Jump to navigation
Jump to search
Title -Documentation by Mikk-
No edit summary |
(Decided that FrameXML is wrong and I'm right =)) |
||
| Line 1: | Line 1: | ||
<center>'''Title''' ''-Documentation by [[user:Mikk|Mikk]]-''</center> | |||
{{ | 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}} | |||
Revision as of 19:47, 16 May 2006
Get the number of entries resulting from your most recent /who query.
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. -- Mikk 15:47, 16 May 2006 (EDT)