Home / Autodocs / dos.library
NAME
- StrToDate
-
Converts a string to a DateStamp (V36)
SYNOPSIS
success = StrToDate( datetime )
D0 D1
BOOL StrToDate( struct DateTime * )
D0 D1
BOOL StrToDate( struct DateTime * )
FUNCTION
Converts a human-readable text string into an AmigaDOS DateStamp.
INPUTS
- DateTime
-
a pointer to an initialized DateTime structure.
- dat_Stamp
-
ignored on input.
- dat_Format
-
a format byte which specifies the format of the dat_StrDat. 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_FUTURE:
-
If set, indicates that strings such as (stored in dat_StrDate) "Monday" refer to "next" monday. Otherwise, if clear, strings like "Monday" refer to "last" monday.
- dat_StrDay
-
ignored by this function.
- dat_StrDate
-
pointer to valid string representing the date. This can be a "DTF_SUBST" style string such as "Today", "Tomorrow", "Monday", or it may be a string as specified by the dat_Format byte. This will be converted to the ds_Days portion of the DateStamp. If this pointer is NULL, DateStamp->ds_Days will not be affected.
- dat_StrTime
-
Pointer to a buffer which contains the time in the text format hh:mm:ss. This will be converted to the ds_Minutes and ds_Ticks portions of the DateStamp. If this pointer is NULL, ds_Minutes and ds_Ticks will be unchanged.
RESULT
- success
-
a zero return indicates that a conversion could not be performed. A non-zero return indicates that the DateTime.dat_Stamp variable contains the converted values.
NOTES
The dat_StrDate and dat_StrTime members must either point to a NUL-terminated string or they must be NULL.
The dat_Format FORMAT_DEF option will only be supported if the locale.library is currently active. Otherwise, FORMAT_DOS will be used instead, which can lead to conversion errors.
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, which can lead to conversion errors.
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.