|
@@ -132,7 +132,28 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="DateOf">
|
|
|
<short>Extract the date part from a DateTime indication.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>DateOf</var> extracts the date part from <var>AValue</var> and returns
|
|
|
+the result.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+Since the <var>TDateTime</var> is actually a double with the date part
|
|
|
+encoded in the integer part, this operation corresponds to a call to
|
|
|
+<var>Trunc</var>.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="TimeOf"/>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="MonthOf"/>
|
|
|
+<link id="DayOf"/>
|
|
|
+<link id="HourOf"/>
|
|
|
+<link id="MinuteOf"/>
|
|
|
+<link id="SecondOf"/>
|
|
|
+<link id="MilliSecondOf"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex1"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -148,6 +169,28 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="TimeOf">
|
|
|
<short>Extract the time part from a DateTime indication.</short>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>TimeOf</var> extracts the time part from <var>AValue</var> and returns
|
|
|
+the result.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+Since the <var>TDateTime</var> is actually a double with the time part
|
|
|
+encoded in the fractional part, this operation corresponds to a call to
|
|
|
+<var>Frac</var>.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="DateOf"/>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="MonthOf"/>
|
|
|
+<link id="DayOf"/>
|
|
|
+<link id="HourOf"/>
|
|
|
+<link id="MinuteOf"/>
|
|
|
+<link id="SecondOf"/>
|
|
|
+<link id="MilliSecondOf"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex2"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -163,6 +206,17 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="IsInLeapYear">
|
|
|
<short>Determine whether a date is in a leap year.</short>
|
|
|
+<descr>
|
|
|
+<var>IsInLeapYear</var> returns <var>True</var> if the year part of <var>AValue</var>
|
|
|
+is leap year, or <var>False</var> if not.
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="IsPM"/>
|
|
|
+<link id="IsToday"/>
|
|
|
+<link id="IsSameDay"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex3"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -178,7 +232,17 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="IsPM">
|
|
|
<short>Determine whether a time is PM or AM.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<var>IsPM</var> returns <var>True</var> if the time part of
|
|
|
+<var>AValue</var> is later then 12:00 (PM, or afternoon).
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="IsInLeapYear"/>
|
|
|
+<link id="IsToday"/>
|
|
|
+<link id="IsSameDay"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex4"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -194,7 +258,25 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="IsValidDate">
|
|
|
<short>Check whether a set of values is a valid date indication.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>IsValidDate</var> returns <var>True</var> when the values <var>AYear</var>,
|
|
|
+<var>AMonth</var>, <var>ADay</var> form a valid date indication. If one of
|
|
|
+the values is not valid (e.g. the day is invalid or does not exist in that
|
|
|
+particular month), <var>False</var> is returned.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+<var>AYear</var> must be in the range 1..9999 to be valid.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<example file="datutex/ex5"/>
|
|
|
+<seealso>
|
|
|
+<link id="IsValidTime"/>
|
|
|
+<link id="IsValidDateTime"/>
|
|
|
+<link id="IsValidDateDay"/>
|
|
|
+<link id="IsValidDateWeek"/>
|
|
|
+<link id="IsValidDateMonthWeek"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -226,6 +308,21 @@
|
|
|
<!-- function result Visibility: default -->
|
|
|
<element name="IsValidTime.Result">
|
|
|
<short><var>True</var> if the given values form a valid time, <var>False</var> if not.</short>
|
|
|
+<descr>
|
|
|
+<var>IsValidTime</var> returns <var>True</var> when the values
|
|
|
+<var>AHour</var>,
|
|
|
+<var>AMinute</var>, <var>ASecond</var> and <var>AMilliSecond</var> form a valid
|
|
|
+time indication. If one of the values is not valid (e.g. the seconds are
|
|
|
+larger than 60), <var>False</var> is returned.
|
|
|
+</descr>
|
|
|
+<example file="datutex/ex6"/>
|
|
|
+<seealso>
|
|
|
+<link id="IsValidDate"/>
|
|
|
+<link id="IsValidDateTime"/>
|
|
|
+<link id="IsValidDateDay"/>
|
|
|
+<link id="IsValidDateWeek"/>
|
|
|
+<link id="IsValidDateMonthWeek"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- argument Visibility: default -->
|
|
@@ -251,7 +348,26 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="IsValidDateTime">
|
|
|
<short>Check whether a set of values is a valid date and time indication.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>IsValidTime</var> returns <var>True</var> when the values
|
|
|
+<var>AYear</var>, <var>AMonth</var>, <var>ADay</var>,
|
|
|
+<var>AHour</var>, <var>AMinute</var>, <var>ASecond</var>
|
|
|
+and <var>AMilliSecond</var> form a valid date and time indication.
|
|
|
+If one of the values is not valid (e.g. the seconds are larger than 60), <var>False</var> is returned.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+<var>AYear</var> must be in the range 1..9999 to be valid.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<example file="datutex/ex7"/>
|
|
|
+<seealso>
|
|
|
+<link id="IsValidDate"/>
|
|
|
+<link id="IsValidTime"/>
|
|
|
+<link id="IsValidDateDay"/>
|
|
|
+<link id="IsValidDateWeek"/>
|
|
|
+<link id="IsValidDateMonthWeek"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -297,6 +413,28 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="IsValidDateDay">
|
|
|
<short>Check whether a given year/day of year combination is a valid date.</short>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>IsValidDateDay</var> returns <var>True</var> if <var>AYear</var> and
|
|
|
+<var>ADayOfYear</var> form a valid date indication, or <var>False</var>
|
|
|
+otherwise.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+<var>AYear</var> must be in the range 1..9999 to be valid.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+The <var>ADayOfYear</var> value is checked to see whether it falls within the valid range of
|
|
|
+dates for <var>AYear</var>.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<example file="datutex/ex9"/>
|
|
|
+<seealso>
|
|
|
+<link id="IsValidDate"/>
|
|
|
+<link id="IsValidTime"/>
|
|
|
+<link id="IsValidDateTime"/>
|
|
|
+<link id="IsValidDateWeek"/>
|
|
|
+<link id="IsValidDateMonthWeek"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -317,6 +455,28 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="IsValidDateWeek">
|
|
|
<short>Check whether a given year/week/day of the week combination is a valid day.</short>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>IsValidDateWeek</var> returns <var>True</var> if <var>AYear</var>,
|
|
|
+<var>AWeekOfYear</var> and <var>ADayOfWeek</var> form a valid date indication,
|
|
|
+or <var>False</var> otherwise.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+<var>AYear</var> must be in the range 1..9999 to be valid.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+The <var>ADayOfWeek</var>,<var>ADayOfWeek</var> values are checked to see whether
|
|
|
+the combination falls within the valid range of weeks for <var>AYear</var>.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<example file="datutex/ex10"/>
|
|
|
+<seealso>
|
|
|
+<link id="IsValidDate"/>
|
|
|
+<link id="IsValidTime"/>
|
|
|
+<link id="IsValidDateTime"/>
|
|
|
+<link id="IsValidDateDay"/>
|
|
|
+<link id="IsValidDateMonthWeek"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -342,7 +502,29 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="IsValidDateMonthWeek">
|
|
|
<short>Check whether a given year/month/week/day of the week combination is a valid day</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>IsValidDateMonthWeek</var> returns <var>True</var> if <var>AYear</var>,
|
|
|
+<var>AMonth</var> <var>AWeekOfMonth</var> and <var>ADayOfWeek</var> form a valid date indication,
|
|
|
+or <var>False</var> otherwise.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+<var>AYear</var> must be in the range 1..9999 to be valid.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+The <var>AWeekOfMonth</var>,<var>ADayOfWeek</var> values are checked to see whether
|
|
|
+the combination falls within the valid range of weeks for the
|
|
|
+<var>AYear</var>,<var>AMonth</var> combination.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<example file="datutex/ex11"/>
|
|
|
+<seealso>
|
|
|
+<link id="IsValidDate"/>
|
|
|
+<link id="IsValidTime"/>
|
|
|
+<link id="IsValidDateTime"/>
|
|
|
+<link id="IsValidDateDay"/>
|
|
|
+<link id="IsValidDateWeek"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -373,7 +555,25 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="WeeksInYear">
|
|
|
<short>return the number of weeks in the year, given a date</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>WeeksInYear</var> returns the number of weeks in the year part of
|
|
|
+<var>AValue</var>. The return value is either 52 or 53.
|
|
|
+</p>
|
|
|
+<remark>
|
|
|
+The first week of the year is determined according to the ISO 8601 standard:
|
|
|
+It is the first week that has at least 4 days in it, i.e. it includes a
|
|
|
+thursday.
|
|
|
+</remark>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="WeeksInAYear"/>
|
|
|
+<link id="DaysInYear"/>
|
|
|
+<link id="DaysInAYear"/>
|
|
|
+<link id="DaysInMonth"/>
|
|
|
+<link id="DaysInAMonth"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex12"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -389,6 +589,25 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="WeeksInAYear">
|
|
|
<short>Return the number of weeks in a given year</short>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>WeeksInAYear</var> returns the number of weeks in the year
|
|
|
+<var>AYear</var>. The return value is either 52 or 53.
|
|
|
+</p>
|
|
|
+<remark>
|
|
|
+The first week of the year is determined according to the ISO 8601 standard:
|
|
|
+It is the first week that has at least 4 days in it, i.e. it includes a
|
|
|
+thursday.
|
|
|
+</remark>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="WeeksInYear"/>
|
|
|
+<link id="DaysInYear"/>
|
|
|
+<link id="DaysInAYear"/>
|
|
|
+<link id="DaysInMonth"/>
|
|
|
+<link id="DaysInAMonth"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex13"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -404,7 +623,20 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="DaysInYear">
|
|
|
<short>Return the number of days in the year in which a date occurs.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>daysInYear</var> returns the number of days in the year part of
|
|
|
+<var>AValue</var>. The return value is either 365 or 366.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="WeeksInAYear"/>
|
|
|
+<link id="WeeksInYear"/>
|
|
|
+<link id="DaysInAYear"/>
|
|
|
+<link id="DaysInMonth"/>
|
|
|
+<link id="DaysInAMonth"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex14"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -420,7 +652,20 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="DaysInAYear">
|
|
|
<short>Number of days in a particular year.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>DaysInAYear</var> returns the number of weeks in the year
|
|
|
+<var>AYear</var>. The return value is either 365 or 366.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="WeeksInAYear"/>
|
|
|
+<link id="WeeksInYear"/>
|
|
|
+<link id="DaysInYear"/>
|
|
|
+<link id="DaysInMonth"/>
|
|
|
+<link id="DaysInAMonth"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex15"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -436,7 +681,20 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="DaysInMonth">
|
|
|
<short>Return the number of days in the month in which a date occurs.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>DaysInMonth</var> returns the number of days in the month in which
|
|
|
+<var>AValue</var> falls. The return value takes leap years into account.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="WeeksInAYear"/>
|
|
|
+<link id="WeeksInYear"/>
|
|
|
+<link id="DaysInYear"/>
|
|
|
+<link id="DaysInAYear"/>
|
|
|
+<link id="DaysInAMonth"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex16"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -452,7 +710,21 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="DaysInAMonth">
|
|
|
<short>Number of days in a month of a certain year.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>DaysInYMonth</var> returns the number of days in the month
|
|
|
+<var>AMonth</var> in the year<var>AYear</var>.
|
|
|
+The return value takes leap years into account.
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="WeeksInAYear"/>
|
|
|
+<link id="WeeksInYear"/>
|
|
|
+<link id="DaysInYear"/>
|
|
|
+<link id="DaysInAYear"/>
|
|
|
+<link id="DaysInMonth"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex17"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -473,6 +745,21 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="Today">
|
|
|
<short>Return the current date</short>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>Today</var> is an alias for the <link
|
|
|
+id="#rtl.sysutils.Date">Date</link> function in the <link
|
|
|
+id="#rtl.sysutils">sysutils</link> unit.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+For an example, see <link id="Yesterday"/>
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="#rtl.sysutils.Date">Date</link>
|
|
|
+<link id="Yesterday"/>
|
|
|
+<link id="Tomorrow"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -483,6 +770,15 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="Yesterday">
|
|
|
<short>Return the previous day.</short>
|
|
|
+<descr>
|
|
|
+<var>Yesterday</var> returns yesterday's date. Yesterday is determined from
|
|
|
+the system clock, i.e. it is <link id="Today"/> -1.
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="Today"/>
|
|
|
+<link id="Tomorrow"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex18"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -493,7 +789,15 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="Tomorrow">
|
|
|
<short>Return the next day</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<var>Tomorrow</var> returns tomorrow's date. Tomorrow is determined from
|
|
|
+the system clock, i.e. it is <link id="Today"/> +1.
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="Today"/>
|
|
|
+<link id="Yesterday"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex19"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -504,7 +808,17 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="IsToday">
|
|
|
<short>Check whether a given date is today.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<var>IsToday</var> returns <var>True</var> if <var>AValue</var> is today's
|
|
|
+date, and <var>False</var> otherwise.
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="Today"/>
|
|
|
+<link id="Yesterday"/>
|
|
|
+<link id="Tomorrow"/>
|
|
|
+<link id="IsSameDay"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex20"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -520,7 +834,18 @@
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="IsSameDay">
|
|
|
<short>Check if two date/time indications are the same day.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<var>IsSameDay</var> checks whether <var>AValue</var> and <var>ABasis</var>
|
|
|
+have the same date part, and returns <var>True</var> if they do,
|
|
|
+<var>False</var> if not.
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="Today"/>
|
|
|
+<link id="Yesterday"/>
|
|
|
+<link id="Tomorrow"/>
|
|
|
+<link id="IsToday"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex21"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -542,6 +867,20 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="PreviousDayOfWeek">
|
|
|
<short>Given a day of the week, return the previous day of the week.</short>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>PreviousDayOfWeek</var> returns the previous day of the week. If the
|
|
|
+current day is the first day of the week (1) then the last day will be
|
|
|
+returned (7).
|
|
|
+</p>
|
|
|
+<remark>
|
|
|
+Note that the days of the week are in ISO notation, i.e. 1-based.
|
|
|
+</remark>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="Yesterday"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex22"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -557,7 +896,20 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="YearOf">
|
|
|
<short>Extract the year from a given date.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<var>YearOf</var> returns the year part of the <var>AValue</var> date/time
|
|
|
+indication. It is a number between 1 and 9999.
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="MonthOf"/>
|
|
|
+<link id="DayOf"/>
|
|
|
+<link id="WeekOf"/>
|
|
|
+<link id="HourOf"/>
|
|
|
+<link id="MinuteOf"/>
|
|
|
+<link id="SecondOf"/>
|
|
|
+<link id="MilliSecondOf"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex23"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -574,7 +926,24 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="MonthOf">
|
|
|
<short>Extract the month from a given date.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>MonthOf</var> returns the month part of the <var>AValue</var> date/time
|
|
|
+indication. It is a number between 1 and 12.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+For an example, see <link id="YearOf"/>
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="DayOf"/>
|
|
|
+<link id="WeekOf"/>
|
|
|
+<link id="HourOf"/>
|
|
|
+<link id="MinuteOf"/>
|
|
|
+<link id="SecondOf"/>
|
|
|
+<link id="MilliSecondOf"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -590,7 +959,24 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="WeekOf">
|
|
|
<short>Extract week (of the year) from a given date.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>WeekOf</var> returns the week-of-the-year part of the <var>AValue</var> date/time
|
|
|
+indication. It is a number between 1 and 53.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+For an example, see <link id="YearOf"/>
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="DayOf"/>
|
|
|
+<link id="MonthOf"/>
|
|
|
+<link id="HourOf"/>
|
|
|
+<link id="MinuteOf"/>
|
|
|
+<link id="SecondOf"/>
|
|
|
+<link id="MilliSecondOf"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -606,7 +992,24 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="DayOf">
|
|
|
<short>Extract the day (of month) part from a DateTime value</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>DayOf</var> returns the day of the month part of the <var>AValue</var> date/time
|
|
|
+indication. It is a number between 1 and 31.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+For an example, see <link id="YearOf"/>
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="WeekOf"/>
|
|
|
+<link id="MonthOf"/>
|
|
|
+<link id="HourOf"/>
|
|
|
+<link id="MinuteOf"/>
|
|
|
+<link id="SecondOf"/>
|
|
|
+<link id="MilliSecondOf"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -622,7 +1025,24 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="HourOf">
|
|
|
<short>Extract the hour part from a DateTime value.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>HourOf</var> returns the hour of the day part of the <var>AValue</var> date/time
|
|
|
+indication. It is a number between 0 and 23.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+For an example, see <link id="YearOf"/>
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="WeekOf"/>
|
|
|
+<link id="MonthOf"/>
|
|
|
+<link id="DayOf"/>
|
|
|
+<link id="MinuteOf"/>
|
|
|
+<link id="SecondOf"/>
|
|
|
+<link id="MilliSecondOf"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -638,7 +1058,24 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="MinuteOf">
|
|
|
<short>Extract the minute part from a DateTime value.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>MinuteOf</var> returns the minute of the hour part of the <var>AValue</var> date/time
|
|
|
+indication. It is a number between 0 and 59.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+For an example, see <link id="YearOf"/>
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="WeekOf"/>
|
|
|
+<link id="MonthOf"/>
|
|
|
+<link id="DayOf"/>
|
|
|
+<link id="HourOf"/>
|
|
|
+<link id="SecondOf"/>
|
|
|
+<link id="MilliSecondOf"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -654,6 +1091,24 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="SecondOf">
|
|
|
<short>Extract the second part from a DateTime value.</short>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>SecondOf</var> returns the second of the minute part of the <var>AValue</var> date/time
|
|
|
+indication. It is a number between 0 and 59.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+For an example, see <link id="YearOf"/>
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="WeekOf"/>
|
|
|
+<link id="MonthOf"/>
|
|
|
+<link id="DayOf"/>
|
|
|
+<link id="HourOf"/>
|
|
|
+<link id="MinuteOf"/>
|
|
|
+<link id="MilliSecondOf"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -669,7 +1124,24 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="MilliSecondOf">
|
|
|
<short>Extract the millisecond part from a DateTime value.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<p>
|
|
|
+<var>MillisecondOf</var> returns the second of the minute part of the <var>AValue</var> date/time
|
|
|
+indication. It is a number between 0 and 999.
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+For an example, see <link id="YearOf"/>
|
|
|
+</p>
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="YearOf"/>
|
|
|
+<link id="WeekOf"/>
|
|
|
+<link id="MonthOf"/>
|
|
|
+<link id="DayOf"/>
|
|
|
+<link id="HourOf"/>
|
|
|
+<link id="MinuteOf"/>
|
|
|
+<link id="MilliSecondOf"/>
|
|
|
+</seealso>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -685,7 +1157,17 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="StartOfTheYear">
|
|
|
<short>Return the first day of the year, given a date in this year.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<var>StartOfTheYear</var> extracts the year part of <var>AValue</var> and
|
|
|
+returns a <var>TDateTime</var> value with the date of the first day of that year (January 1), as the
|
|
|
+<link id="StartOfAYear"/> function.
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="StartOfAYear"/>
|
|
|
+<link id="EndOfTheYear"/>
|
|
|
+<link id="EndOfAYear"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex24"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -703,7 +1185,17 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="EndOfTheYear">
|
|
|
<short>Calculate a DateTime value representing the last day of a year, given a date in that year.</short>
|
|
|
-<descr/>
|
|
|
+<descr>
|
|
|
+<var>EndOfTheYear</var> extracts the year part of <var>AValue</var> and
|
|
|
+returns a <var>TDateTime</var> value with the date of the last day of that year (December 31), as the
|
|
|
+<link id="EndOfAYear"/> function.
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="StartOfAYear"/>
|
|
|
+<link id="StartOfTheYear"/>
|
|
|
+<link id="EndOfAYear"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex25"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -719,6 +1211,15 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="StartOfAYear">
|
|
|
<short>Return the first day of a given year.</short>
|
|
|
+<descr>
|
|
|
+<var>StartOfAYear</var> returns a <var>TDateTime</var> value with the date of the first day of the year <var>AYear</var> (January 1).
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="StartOfTheYear"/>
|
|
|
+<link id="EndOfTheYear"/>
|
|
|
+<link id="EndOfAYear"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex26"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|
|
@@ -734,6 +1235,16 @@ day, <var>False</var> otherwise..</short>
|
|
|
<!-- function Visibility: default -->
|
|
|
<element name="EndOfAYear">
|
|
|
<short>Calculate a DateTime value representing the last day of a year</short>
|
|
|
+<descr>
|
|
|
+<var>StartOfAYear</var>
|
|
|
+returns a <var>TDateTime</var> value with the date of the last day of the year <var>AYear</var> (December 31).
|
|
|
+</descr>
|
|
|
+<seealso>
|
|
|
+<link id="StartOfTheYear"/>
|
|
|
+<link id="EndOfTheYear"/>
|
|
|
+<link id="EndOfAYear"/>
|
|
|
+</seealso>
|
|
|
+<example file="datutex/ex27"/>
|
|
|
</element>
|
|
|
|
|
|
<!-- function result Visibility: default -->
|