![]() |
LongDateString |
||||
Header: | DateTimeUtils.h | Carbon status: | Supported | |
Converts a date that is specified as a LongDateTime value into a Pascal string, making use of the date formatting information in the specified resource.
void LongDateString ( LongDateTime *dateTime, DateForm longFlag, Str255 result, Handle intlHandle );
A pointer to a 64-bit, signed representation of the number of seconds since Jan. 1, 1904. This allows coverage of a much longer span of time (plus or minus approximately 30,000 years) than the standard, 32-bit representation.
A flag that indicates the desired format for the date string. This is one of the three values defined as the DateForm type.
The string produced by LongDateString is in one of three standard date formats used on the Macintosh, depending on which of the three DateForm values that you specify for the longFlag parameter: shortDate, abbrevDate, or longDate. The information in the supplied resource defines how month and day names are written and provides for calendars with more than 7 days and more than 12 months.
For the U.S. resource, the date January 31, 1991, produces the following three strings: 1/31/92, Fri, Jan 31, 1992, and Fri, January 31, 1992 (for DateForm values shortDate, abbrevDate, and longDate, respectively).
On output, contains the string representation of the date in the format indicated by the longFlag parameter.
A handle to a numeric-format or long-date-format resource that specifies date formatting information for use in the conversion. If you specify NULL as the value of the resource handle parameter, LongDateString uses information from the current script.The numeric-format ('itl0') resource specifies the short date formats and the long-date-format ('itl1') resource specifies the long date formats.
If you specify shortDate in the longFlag parameter, the intlHandle value should be the handle to a numeric-format resource; if you specify abbrevDate or longDate, it should be the handle to a long-date-format resource.
You can use the LongSecondsToDate and LongDateToSeconds functions to convert between the LongDateRec (as produced by the StringToDate function) and LongDateTime data types.
LongDateString may move memory; your application should not call this function at interrupt time.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.
© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)