Home / Autodocs / dos.library
NAME
- DateToStr
-
Converts a DateStamp to a string (V36)
SYNOPSIS
success = DateToStr( datetime )
D0 D1
BOOL DateToStr(struct DateTime *)
D0 D1
BOOL DateToStr(struct DateTime *)
FUNCTION
StamptoStr converts an AmigaDOS DateStamp to a human-readable text string as requested by your settings in the DateTime structure.
INPUTS
- DateTime
-
a pointer to an initialized DateTime structure.
- dat_Stamp
-
a copy of the DateStamp you wish to convert to a text string.
- dat_Format
-
a format byte which specifies the format of the dat_StrDate. This can be any of the following (Note: If the value used is something other than those below, the default of FORMAT_DOS will be used):
- FORMAT_DOS
-
AmigaDOS format (dd-mmm-yy).
- FORMAT_INT
-
International format (yy-mmm-dd).
- FORMAT_USA
-
American format (mm-dd-yy).
- FORMAT_CDN
-
Canadian format (dd-mm-yy).
- FORMAT_DEF
-
default format for locale.
- dat_Flags
-
a flags byte. The only flag which affects this function is:
- DTF_SUBST
-
If set, a string such as Today, Monday, etc., will be used instead of the dat_Format specification if possible.
- dat_StrDay
-
pointer to a buffer to receive the day of the week string (Monday, Tuesday, etc.). If NULL, this string will not be generated. See NOTES below for the minimum size of the string buffer.
- dat_StrDate
-
pointer to a buffer to receive the date string, in the format requested by dat_Format, subject to possible modifications by DTF_SUBST. If NULL, this string will not be generated. See NOTES below for the minimum size of the string buffer.
- dat_StrTime
-
pointer to a buffer to receive the time of day string. If NULL, this string will not be generated. See NOTES below for the minimum size of the string buffer.
RESULT
- success
-
A zero return indicates that the DateStamp was invalid, and could not be converted. Non-zero indicates that the call succeeded.
NOTES
The string buffers pointed to by the dat_StrDay, dat_StrDate and dat_StrTime members must be at least LEN_DATSTRING bytes in size (including the terminating NUL byte).
The dat_Format FORMAT_DEF option will only be supported if the locale.library is currently active. Otherwise, FORMAT_DOS will be used instead.
If locale.library is active, the names of days and months will be used in localized format. The format itself is defined by the choice of dat_Format.
The dat_Format FORMAT_DEF option will only be supported if the locale.library is currently active. Otherwise, FORMAT_DOS will be used instead.
If locale.library is active, the names of days and months will be used in localized format. The format itself is defined by the choice of dat_Format.