Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

external/CDAWlib/jh/

monthnames.pro


NAME: MONTHNAMES PURPOSE: Returns a string array of month names. CATEGORY: CALLING SEQUENCE: mnam = monthnames([num]) INPUTS: num = optional month number (can be array). in KEYWORD PARAMETERS: Keywords: /FULL return full month name (else 3 letters only). /UPPER force all upper case (else mixed). /LOWER force all lower case (else mixed). /ORDER adds the month number at front, like 04_Apr, so the strings will sort in time order. Useful in file names. /NOZERO Drop element 0 when returning an array of all months. The purpose of element 0 was to allow indexing into the array using the month number. But for generating a list of file names that may not be wanted. OUTPUTS: mnam = returned month name(s). out if num not given or is 0 a string array of all months is returned: ['Error','January',...'December'] modified by the keywords. COMMON BLOCKS: NOTES: MODIFICATION HISTORY: R. Sterner, 18 Sep, 1989 R. Sterner, 2001 May 24 --- Now returns name of given month. R. Sterner, 2010 May 04 --- Converted arrays from () to []. R. Sterner, 2012 Mar 09 --- Added /ORDER, cleaned up code. R. Sterner, 2012 Mar 09 --- Added /NOZERO. Copyright (C) 1989, Johns Hopkins University/Applied Physics Laboratory This software may be used, copied, or redistributed as long as it is not sold and this copyright notice is reproduced on each copy made. This routine is provided as is without any express or implied warranties whatsoever. Other limitations apply as described in the file disclaimer.txt.

Routines

top source monthnames

result = monthnames(num0, upper=upper, lower=lower, full=full, order=order, nozero=nozero, help=help)

Parameters

num0

Keywords

upper
lower
full
order
nozero
help

File attributes

Modification date: Tue Oct 21 13:53:43 2014
Lines: 39