WoW:API GetNumAuctionItems: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(upgraded deprecated template)
(Removed inaccurate and unnecessary note for batch return.)
Line 18: Line 18:
;''Returns''
;''Returns''


:;batch : The size of the batch, seems to be MIN(NUM_AUCTION_ITEMS_PER_PAGE,count)
:;batch : The size of the batch.
:;count : The number of items.
:;count : The total number of items.


----
----
;''Example''
;''Example''
  numBatchAuctions, totalAuctions = GetNumAuctionItems("bidder");
  numBatchAuctions, totalAuctions = GetNumAuctionItems("bidder");

Revision as of 03:36, 7 July 2007

WoW API < GetNumAuctionItems

GetNumAuctionItems -Documentation by taka-

Retrieves the number of auction items of a certain type.

batch,count = GetNumAuctionItems("list");

Arguments
(string type)
type
One of the following:
"list"
Items up for auction, the "Browse" tab in the dialog.
"bidder"
Items the player has bid on, the "Bids" tab in the dialog.
"owner"
Items the player has up for auction, the "Auctions" tab in the dialog.

Returns
batch
The size of the batch.
count
The total number of items.

Example
numBatchAuctions, totalAuctions = GetNumAuctionItems("bidder");