WoW:API GetNumWhoResults

From AddOn Studio
Revision as of 19:47, 16 May 2006 by WoWWiki>Mikk (Decided that FrameXML is wrong and I'm right =))
Jump to navigation Jump to search
Title -Documentation by Mikk-

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)



Template:WoW API