WoW:API GetAuctionItemLink: Difference between revisions

Revision as of 12:00, 6 May 2007

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

Retrieves the itemLink of one item in the current retrieved list of items from the Auction House.

"itemLink" = GetAuctionItemLink("type", index)

("type", index)

"type"

String - One of the following:

"list": An item up for auction, the "Browse" tab in the dialog.
"bidder": An item the player has bid on, the "Bids" tab in the dialog.
"owner": An item the player has up for auction, the "Auctions" tab in the dialog.

index: Number - The index of the item in the list to retrieve info from (normally 1-50, inclusive)

"itemLink": itemLink - The itemLink for the specified item or; nil, if type and/or index is invalid.

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}} __NOTOC__
- <center>'''GetAuctionItemLink''' ''-Documentation by ClydeJr-''</center>
-Retrieves a link string about one item in the current retrieved list of items from the Auction House.
+Retrieves the [[itemLink]] of one item in the current retrieved list of items from the Auction House.
-  link = GetAuctionItemLink("type", index);
+  "itemLink" = GetAuctionItemLink("type", index)
-----
+== Arguments ==
-;''Arguments''
+:("type", index)
-:(String type, Number index)
+:;"type" : String - One of the following:
-:;type : One of the following:
 :::;"list" : An item up for auction, the "Browse" tab in the dialog.
 :::;"bidder" : An item the player has bid on, the "Bids" tab in the dialog.
 :::;"owner" : An item the player has up for auction, the "Auctions" tab in the dialog.
+:;index : Number - The index of the item in the list to retrieve info from (normally 1-50, inclusive)
-:;index : The index of the item in the list to retrieve info from (normally 1-50, inclusive)
+== Returns ==
+:;"itemLink" : [[itemLink]] - The itemLink for the specified item or
-----
+:: nil, if type and/or index is invalid.
-;''Returns''
-:;link : The link string for the specified item, or nil if the slot is empty.
-----
-;''Description''
-: Retrieves a link string about an item in the current list of auction items.