WoW:API CalendarOpenEvent: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(New page: {{wowapi}} __NOTOC__ Establishes an event for future calendar calls CalendarOpenEvent(monthOffset, day, eventIndex) == Arguments == :(monthOffset, day, eventIndex) :;monthOffset : Nu...)
 
(Testing indicates that argument 'day' is a day of the month, not an offset from the current day in v30100)
Line 10: Line 10:


:;monthOffset : Number - The number of months to offset from today
:;monthOffset : Number - The number of months to offset from today
:;day : Number - The number of days to offset from today
:;day : Number - The day of the month on which the desired event is scheduled (1 - 31)
:;eventIndex : Number - The index of the desired event, From 1 through CalendarGetNumDayEvents(monthOffset, day)
:;eventIndex : Number - The index of the desired event, From 1 through CalendarGetNumDayEvents(monthOffset, day)



Revision as of 20:28, 30 April 2009

WoW API < CalendarOpenEvent

Establishes an event for future calendar calls

CalendarOpenEvent(monthOffset, day, eventIndex)


Arguments

(monthOffset, day, eventIndex)
monthOffset
Number - The number of months to offset from today
day
Number - The day of the month on which the desired event is scheduled (1 - 31)
eventIndex
Number - The index of the desired event, From 1 through CalendarGetNumDayEvents(monthOffset, day)

Details

You must call this function before making calls to CalendarEventGetNumInvites() and CalendarEventGetInvite(). CalendarOpenEvent() tells the application which event you're working with. Presumably this is to reduce memory usage and load on the server