GBBopen 1.5 Reference -- internet-text-date-and-time

internet-text-date-and-time

internet-text-date-and-time &optional universal-time &key time-zone daylight-savings-p utc-offset-only destination => result [Function]

Purpose
Convert a Universal Time value into Internet Text Message format.

Package :gbbopen-tools

Module :gbbopen-tools

Arguments and values

universal-time		A Universal Time (default is `nil`, which is equivalent to the value returned by `(get-universal-time)`)
time-zone		A time zone (default is `nil`, which is equivalent to the current time zone adjusted for daylight saving time)
daylight-savings-p		A generalized boolean (default is `nil`)
utc-offset-only		A generalized boolean (default is `nil`)
destination		Either `nil`, `t`, a stream, or a string with a fill pointer (default is `nil`)
result		A string or `nil`

Returns
If destination is non-nil, then nil; otherwise, a string.

Description
If universal-time is not supplied or is nil, the current time (as returned by get-universal-time is used.

If utc-offset-only is true, the time zone is represented as a UTC offset—even if a time-zone abbreviation supported by GBBopen Tools is available for the time zone. If a time-zone is supplied, the value of daylight-savings-p is used when generating a non-UTC time zone abbreviation; otherwise, the local daylight-savings setting for the universal-time value (as determined by decode-universal-time) is used, and the daylight-savings-p argument is ignored.

Examples

  > (internet-text-date-and-time)
  "Sat, 17 May 2008 04:02:49 -0400 (EDT)"
  > (internet-text-date-and-time nil :time-zone 0)
  "Sat, 17 May 2008 08:02:50 -0000 (GMT)"
  >

The GBBopen Project

internet-text-date-and-time