Date$: Difference between revisions
No edit summary |
|||
| Line 1: | Line 1: | ||
Date$([days],[[*]format$]) | Date$([days],[[*]format$]) | ||
The '''Date$''' [[internal function]] returns the date as a formatted string which includes optional punctuation marks as separators between the month, day, and year. | The '''Date$''' [[internal function]] returns the date as a formatted string which includes optional punctuation marks as separators between the month, day, and year. | ||
====Comments and Examples==== | ====Comments and Examples==== | ||
The four examples below all change the date format temporarily so that the month will print before the day of the month, which will print before the year. For a system date of December 25, 1988, the printed output is given as a comment at the end of the line for each example. | The four examples below all change the date format temporarily so that the month will print before the day of the month, which will print before the year. For a system date of December 25, 1988, the printed output is given as a comment at the end of the line for each example. | ||
00010 PRINT DATE$("mm-dd-yy") ! 12-25-88 | 00010 PRINT DATE$("mm-dd-yy") ! 12-25-88 | ||
00020 PRINT DATE$("m | 00020 PRINT DATE$("m.d.y") ! 12.25.88 | ||
00030 PRINT DATE$("MM | 00030 PRINT DATE$("DD/MM/YY") ! 25/12/88 | ||
00040 PRINT DATE$("MMDDYY") | 00040 PRINT DATE$("MMDDYY") ! 122588 | ||
00050 PRINT DATE$ | 00050 PRINT DATE$ ! 88/12/25 | ||
NOTICE in line 50 that the output automatically returns to the default format. When | NOTICE in line 50 that the output automatically returns to the default format. When BR is started, the default format is yy/mm/dd. Other possible uses of Date$ include returning ''only'' the day, month, year or century. | ||
00050 PRINT DATE$("m") | 00050 PRINT DATE$("m") ! 12 | ||
00060 PRINT DATE$("D") | 00060 PRINT DATE$("D") ! 25 | ||
00070 PRINT DATE$("y") | 00070 PRINT DATE$("y") ! 88 | ||
00080 PRINT DATE$("m-d-cy") | 00080 PRINT DATE$("m-d-cy") ! 12-25-1988 | ||
00090 PRINT DATE$("C") | 00090 PRINT DATE$("C") ! 19 | ||
The optional numeric parameter (days) allows specifying a day of the century. The following example assumes the system date is Christmas, 1988. | The optional numeric parameter (days) allows specifying a day of the century. The following example assumes the system date is Christmas, 1988. | ||
00010 PRINT DATE$("*mm-dd-ccyy") ! 12-25-1988 | 00010 PRINT DATE$("*mm-dd-ccyy") ! 12-25-1988 | ||
00020 PRINT DATE$(1) | 00020 PRINT DATE$(1) ! 01-02-1900 | ||
00030 PRINT DATE$(366) | 00030 PRINT DATE$(366) ! 01-01-1901 | ||
00040 PRINT DATE$(Days(DATE)) | 00040 PRINT DATE$(Days(DATE)) ! 12-25-1988 | ||
00050 PRINT DATE$(Days(DATE)+10) ! 01-04-1989 | 00050 PRINT DATE$(Days(DATE)+10) ! 01-04-1989 | ||
| Line 45: | Line 46: | ||
====Parameters==== | ====Parameters==== | ||
When the Date$ function is used without parameters, it returns the current system date in the current default format, which is yy/mm/dd when Business Rules is started. | When the Date$ function is used without parameters, it returns the current system date in the current default format, which is yy/mm/dd when Business Rules is started. | ||
The optional "days" parameter represents the desired date as a sequential value in relation to a base date of January 1, 1900. Thus January 2, 1900 would have a days value of 1 | The optional "days" parameter represents the desired date as a sequential value in relation to a base date of January 1, 1900. Thus January 2, 1900 would have a days value of 1. January 2, 1901 would have a days value of 366, since 1900 was not a leap year. | ||
The optional "format$" parameter is a string expression which identifies the format of the value to be returned. When the first character of the string expression is an asterisk (*), it identifies the default format which should be used by the Date, Date$ and Days parameters until the | The optional "format$" parameter is a string expression which identifies the format of the value to be returned. When the first character of the string expression is an asterisk (*), it identifies the default format which should be used by the Date, Date$ and Days parameters until the computer exits Business Rules or until the format is changed again. Format changes affect the current computer only. | ||
The format$ parameter may include editing characters and any of the following date specifications: D (day), M (month), Y (year) or C (century). The total number of editing characters and date specifications may not exceed 6. Consecutive repetitions (DDD, YY, etc.) of the date specifications count as just one specification, but consecutive repetitions of editing characters do not use this rule. | The format$ parameter may include editing characters and any of the following date specifications: D (day), M (month), Y (year) or C (century). The total number of editing characters and date specifications may not exceed 6. Consecutive repetitions (DDD, YY, etc.) of the date specifications count as just one specification, but consecutive repetitions of editing characters do not use this rule. | ||
| Line 61: | Line 63: | ||
# If the string parameter begins with an asterisk (*), then the default format is changed. The default format affects results of the Date, Date$ and Days functions. This change applies only to the current workstation and stays in effect until you leave Business Rules. | # If the string parameter begins with an asterisk (*), then the default format is changed. The default format affects results of the Date, Date$ and Days functions. This change applies only to the current workstation and stays in effect until you leave Business Rules. | ||
====Additional Supported Date Formats==== | |||
DATE$(days,"day month, ccyy") -> 23 January, 2007<br> | DATE$(days,"day month, ccyy") -> 23 January, 2007<br> | ||
| Line 68: | Line 70: | ||
====Related Functions==== | ====Related Functions==== | ||
See also [[Date]] and [[Days]] for other date processing functions. To set the system date, use the [[Date command]]. For other features especially useful in markets outside the United States, see the [[INVP]] parameter of the [[Option]] statement and the [[Pic$]] function | See also [[Date]] and [[Days]] for other date processing functions. To set the system date, use the [[Date command]]. For other features especially useful in markets outside the United States, see the [[INVP]] parameter of the [[Option]] statement and the [[Pic$]] function | ||
Revision as of 09:20, 24 January 2012
Date$([days],[[*]format$])
The Date$ internal function returns the date as a formatted string which includes optional punctuation marks as separators between the month, day, and year.
Comments and Examples
The four examples below all change the date format temporarily so that the month will print before the day of the month, which will print before the year. For a system date of December 25, 1988, the printed output is given as a comment at the end of the line for each example.
00010 PRINT DATE$("mm-dd-yy") ! 12-25-88
00020 PRINT DATE$("m.d.y") ! 12.25.88
00030 PRINT DATE$("DD/MM/YY") ! 25/12/88
00040 PRINT DATE$("MMDDYY") ! 122588
00050 PRINT DATE$ ! 88/12/25
NOTICE in line 50 that the output automatically returns to the default format. When BR is started, the default format is yy/mm/dd. Other possible uses of Date$ include returning only the day, month, year or century.
00050 PRINT DATE$("m") ! 12
00060 PRINT DATE$("D") ! 25
00070 PRINT DATE$("y") ! 88
00080 PRINT DATE$("m-d-cy") ! 12-25-1988
00090 PRINT DATE$("C") ! 19
The optional numeric parameter (days) allows specifying a day of the century. The following example assumes the system date is Christmas, 1988.
00010 PRINT DATE$("*mm-dd-ccyy") ! 12-25-1988
00020 PRINT DATE$(1) ! 01-02-1900
00030 PRINT DATE$(366) ! 01-01-1901
00040 PRINT DATE$(Days(DATE)) ! 12-25-1988
00050 PRINT DATE$(Days(DATE)+10) ! 01-04-1989
Lines 10 and 20 above could be combined into line 500 below.
00500 PRINT DATE$(1,"*mm-dd-ccyy") ! 01-02-1900
As the above specification includes the asterisk, the default format for all future uses of the Date, Date$ and Days functions is changed to mm-dd-ccyy, as specified.
The following is a short program that will center "July 4, 1988" (or any other value set by the Date command) at the top of a report.
00010 DIM MONTH$(12)*9
00020 READ MAT MONTH$
00030 DATA "January ","February ","March ","April ","May "
00040 DATA "June ","July ","August ","September ","October "
00050 DATA "November ","December "
00060 PRINT #255,USING 70: MONTH$(DATE("m")) & DATE$("d, cy")
00070 FORM CC 132
Parameters
When the Date$ function is used without parameters, it returns the current system date in the current default format, which is yy/mm/dd when Business Rules is started.
The optional "days" parameter represents the desired date as a sequential value in relation to a base date of January 1, 1900. Thus January 2, 1900 would have a days value of 1. January 2, 1901 would have a days value of 366, since 1900 was not a leap year.
The optional "format$" parameter is a string expression which identifies the format of the value to be returned. When the first character of the string expression is an asterisk (*), it identifies the default format which should be used by the Date, Date$ and Days parameters until the computer exits Business Rules or until the format is changed again. Format changes affect the current computer only.
The format$ parameter may include editing characters and any of the following date specifications: D (day), M (month), Y (year) or C (century). The total number of editing characters and date specifications may not exceed 6. Consecutive repetitions (DDD, YY, etc.) of the date specifications count as just one specification, but consecutive repetitions of editing characters do not use this rule.
The following rules apply to the format$ parameter for the Date$, Date and Days functions:
- The D, M, Y and C specifications may be specified in either uppercase or lowercase letters.
- Consecutive repetitions of the D, M, Y or C specifications count as just one specification. Thus DDDD is one specification, and cc is one specification.
- All characters other than D, M, Y or C are considered editing characters, and are ignored for the numeric Date function.
- A maximum of six specifications are allowed. DD counts as one. Each punctuation mark counts as one. Date$("mm-dd-ccyy") uses the maximum. Date$("mm -dd -yy") would result in error code 0411 (date format string too long) because there are three date specifications and four editing characters for a total of seven specifications.
- If the string parameter begins with an asterisk (*), then the default format is changed. The default format affects results of the Date, Date$ and Days functions. This change applies only to the current workstation and stays in effect until you leave Business Rules.
Additional Supported Date Formats
DATE$(days,"day month, ccyy") -> 23 January, 2007
DATE$(days,"d3 m3 dd, ccyy") -> Tue Jan 10, 2005
DAYS("January 17, 1945", "month dd, ccyy")
Related Functions
See also Date and Days for other date processing functions. To set the system date, use the Date command. For other features especially useful in markets outside the United States, see the INVP parameter of the Option statement and the Pic$ function