WoW:API GetNumWhoResults: Difference between revisions

Latest revision as of 07:14, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

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

  numWhos, totalCount = GetNumWhoResults();

None

totalCount, numWhos

This function only returns the last /who query results after the "WHO_LIST_UPDATE" event has fired.

@@ 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.
+   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
@@ Line 15: / Line 13: @@
 :;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__