WoW:API CalendarGetMonth: Difference between revisions
Jump to navigation
Jump to search
(New page: {{wowapi}} __NOTOC__ <!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> Retrieve the month and year for the given offset of months. <!-- Lis...) |
No edit summary |
||
| Line 4: | Line 4: | ||
Retrieve the month and year for the given offset of months. | Retrieve the month and year for the given offset of months. | ||
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | <!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | ||
month, year, numdays = CalendarGetMonth( offsetMonth ); | month, year, numdays, firstday = CalendarGetMonth( [offsetMonth] ); | ||
| Line 11: | Line 11: | ||
:(offsetMonth) | :(offsetMonth) | ||
:;offsetMonth : Number - The number of months to offset from the current month. | :;offsetMonth (optional) : Number - The number of months to offset from the current month. If excluded, the function returns data for the current month. | ||
== Returns == | == Returns == | ||
<!-- List each return value, together with its type --> | <!-- List each return value, together with its type --> | ||
:month, year, numdays | :month, year, numdays, firstday | ||
:;month : Number - The month in integer format (1-12) | :;month : Number - The month in integer format (1-12) | ||
:;year : Number - The year at the offset date | :;year : Number - The year at the offset date | ||
:;numdays : Number - The number of days in the month (28-31) | :;numdays : Number - The number of days in the month (28-31) | ||
:;firstday : Number - The weekday on which the month begins (1 = Sunday, 2 = Monday, ..., 7 = Saturday) | |||
Revision as of 04:11, 17 September 2008
Retrieve the month and year for the given offset of months.
month, year, numdays, firstday = CalendarGetMonth( [offsetMonth] );
Arguments
- (offsetMonth)
- offsetMonth (optional)
- Number - The number of months to offset from the current month. If excluded, the function returns data for the current month.
Returns
- month, year, numdays, firstday
- month
- Number - The month in integer format (1-12)
- year
- Number - The year at the offset date
- numdays
- Number - The number of days in the month (28-31)
- firstday
- Number - The weekday on which the month begins (1 = Sunday, 2 = Monday, ..., 7 = Saturday)