WoW:API GetNumAuctionItems: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Move page script moved page API GetNumAuctionItems to API GetNumAuctionItems without leaving a redirect)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<center>'''GetNumAuctionItems''' ''-Documentation by taka-''</center>
{{wowapi}}


Retrieves the number of auction items of a certain type.
Retrieves the number of auction items of a certain type.
Line 17: Line 17:
;''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");
----
{{Template:WoW API}}
[[Category:API Functions|GetNumAuctionItems]]
[[Category:API Auction Functions|GetNumAuctionItems]]

Latest revision as of 04:46, 15 August 2023

WoW API < GetNumAuctionItems

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");