# coyote: THEMONTHS

- coyote/Utilities
- [Source code]

NAME

      TheMonths

PURPOSE

      This is a utility program for obtaining the months of the
      year in various string formats. Primarily used for graphic
      labeling and the like.

AUTHOR

      FANNING SOFTWARE CONSULTING
      David Fanning, Ph.D.
      1645 Sheely Drive
      Fort Collins, CO 80526 USA
      Phone: 970-221-0438
      E-mail: david@idlcoyote.com
      Coyote's Guide to IDL Programming: http://www.idlcoyote.com

CATEGORY

      Utilites

CALLING SEQUENCE

      listOfMonths = theMonths()

RETURN VALUE

      listOfMonths: The list of months as a string or string array,
                    depending upon which keywords are set.

INPUTS

      index:        The index of the month you are interested in
                    returning. Integer from 1 to 12.
      RDS:
      ABBREVIATION: Set this keyword if you wish to return the months
                    as a three letter abbreviation.
      ALLCAPS:      Set this keyword if you wish to return the months
                    in all capital letters. (Default is first letter
                    capitalized.)
      FIRSTLETTER:  Set this keyword to return just the first letter
                    of the months.
      LOWCASE:      Set this keyword to return all lowercase letters.

MODIFICATION HISTORY

      Written by David W. Fanning, 8 Nov 2007.
      Retired 9 January 2013 and replaced with cgMonths.

******************************************************************************************;

Return to caller on error.

; Was a month index passed in tothe program?

; Define the months.

; If an index was returned, return that month.

; Otherwise return all the months.