AT&T Home | AT&T Labs | Research
AT&T Labs, Inc. - Research

The Yoix® Scripting Language

Home | What's New | Grammar | Documentation | Download | License | YChart | YDAT | YWAIT | Byzgraf | FAQs
getDateFormat ([Locale locale [, int localized [, int type [, int style]]]]) yoix.util
getDateFormat (Locale locale, int localized, int type, int datestyle, int timestyle)  
 
Returns a format string based on the supplied arguments. With no arguments, the default Yoix date / time format string is returned, namely "EEE MMM dd HH:mm:ss zzz yyyy". When locale is supplied, a locale-specific format is returned. When localized is supplied and is non-zero, the format characters in the locale-specific format will be translated from format characters used in the default locale into format characters used in the locale specified by locale. For example, in the Spanish (Colombia) locale, the u instead of y is the letter used to represent a year digit.

The remaining arguments, when supplied, should be assigned values that are defined in the yoix.util.DateFormat dictionary. The type should be DATE, TIME, or DATETIME, and indicates whether just the date portion, just the time portion, or both the date and time should be included in the format. The style, datestyle, and timestyle should be SHORT, MEDIUM, LONG, FULL, or DEFAULT. When five arguments are supplied, then both the datestyle and timestyle are specified, in that order, regardless of the value of type.
 
 Example:   Refer to the getCalendarLocales documentation for a usage example involving getDateFormat.
 
 Return:   String
 
 See Also:   date, getCalendarLocales, getLocale, parseDate

 

Yoix is a registered trademark of AT&T Inc.