WoW:API GetInboxHeaderInfo: Difference between revisions

WoW:API GetInboxHeaderInfo (source)

Revision as of 23:05, 23 December 2006

379 bytes removed , 23 December 2006

{{wowapi}}, format

Anonymous user

WoWWiki>Starlightblunder

@@ Line 1: / Line 1: @@
-<center>'''GetInboxHeaderInfo(index)''' ''-Documentation by [[user:BaHaMuTNeO]], [[user:Flickering|Flickering]] -''</center>
+{{wowapi}} __NOTOC__
+Returns information about an item in the mailbox.
+ packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply = GetInboxHeaderInfo(index);
-packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply = GetInboxHeaderInfo(index);
+==Parameters==
+===Arguments===
-Returns information about a mailbox item.
-----
-;''Arguments''
-:(index)
 :;index : Number - the index of the message (1 is the first message)
+===Returns===
-----
-;''Returns''
-packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply
 :;packageIcon : String - texture path for package icon if it contains a package (nil otherwise)
 :;stationeryIcon : String - texture path for mail message icon.
@@ Line 29: / Line 20: @@
 :;canReply : Flag - 1 if this letter can be replied to, nil otherwise
-----
+==Example==
-;''Example''
-<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
   local packageTexture = GetInboxHeaderInfo(1);
+===Result===
-;''Result''
 packageTexture is "Interface\Icons\INV_Scroll_03.blp"
-----
+==Notes==
-;''Details''
 This function may be called from anywhere in the world, but will only be current as of the last time [[API_CheckInbox|CheckInbox()]] was called.
-----
-{{Template:WoW API}}