dateutils.xml 107 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788
  1. <?xml version="1.0"?>
  2. <fpdoc-descriptions>
  3. <package name="rtl">
  4. <!--
  5. ====================================================================
  6. dateutils
  7. ====================================================================
  8. -->
  9. <module name="dateutils">
  10. <short>Date/Time manipulation routines.</short>
  11. <descr/>
  12. <!-- unresolved type reference Visibility: default -->
  13. <element name="SysUtils">
  14. <short>Exception support</short>
  15. </element>
  16. <!-- unresolved type reference Visibility: default -->
  17. <element name="Math">
  18. <short>Math support</short>
  19. </element>
  20. <!-- unresolved type reference Visibility: default -->
  21. <element name="Types">
  22. <short>Basic types</short>
  23. </element>
  24. <!-- constant Visibility: default -->
  25. <element name="DaysPerWeek">
  26. <short>Number of days in a week.</short>
  27. </element>
  28. <!-- constant Visibility: default -->
  29. <element name="WeeksPerFortnight">
  30. <short>Number of weeks in fortnight</short>
  31. </element>
  32. <!-- constant Visibility: default -->
  33. <element name="MonthsPerYear">
  34. <short>Number of months in a year</short>
  35. </element>
  36. <!-- constant Visibility: default -->
  37. <element name="YearsPerDecade">
  38. <short>Number of years in a decade</short>
  39. </element>
  40. <!-- constant Visibility: default -->
  41. <element name="YearsPerCentury">
  42. <short>Number of years in a century</short>
  43. </element>
  44. <!-- constant Visibility: default -->
  45. <element name="YearsPerMillennium">
  46. <short>Number of years in a millenium</short>
  47. </element>
  48. <!-- constant Visibility: default -->
  49. <element name="DayMonday">
  50. <short>ISO day number for Monday</short>
  51. </element>
  52. <!-- constant Visibility: default -->
  53. <element name="DayTuesday">
  54. <short>ISO day number for Tuesday</short>
  55. </element>
  56. <!-- constant Visibility: default -->
  57. <element name="DayWednesday">
  58. <short>ISO day number for Wednesday</short>
  59. </element>
  60. <!-- constant Visibility: default -->
  61. <element name="DayThursday">
  62. <short>ISO day number for Thursday</short>
  63. </element>
  64. <!-- constant Visibility: default -->
  65. <element name="DayFriday">
  66. <short>ISO day number for Friday</short>
  67. </element>
  68. <!-- constant Visibility: default -->
  69. <element name="DaySaturday">
  70. <short>ISO day number for Saturday</short>
  71. </element>
  72. <!-- constant Visibility: default -->
  73. <element name="DaySunday">
  74. <short>ISO day number for Sunday</short>
  75. </element>
  76. <!-- constant Visibility: default -->
  77. <element name="OneHour">
  78. <short>One hour as a fraction of a day (suitable for TDateTime)</short>
  79. </element>
  80. <!-- constant Visibility: default -->
  81. <element name="OneMinute">
  82. <short>One minute as a fraction of a day (suitable for TDateTime)</short>
  83. </element>
  84. <!-- constant Visibility: default -->
  85. <element name="OneSecond">
  86. <short>One second as a fraction of a day (suitable for TDateTime)</short>
  87. </element>
  88. <!-- constant Visibility: default -->
  89. <element name="OneMillisecond">
  90. <short>One millisecond as a fraction of a day (suitable for TDateTime)</short>
  91. </element>
  92. <!-- constant Visibility: default -->
  93. <element name="DaysPerYear">
  94. <short>Array with number of days in a year. The boolean index indicates whether it is a leap year or not.</short>
  95. </element>
  96. <!-- constant Visibility: default -->
  97. <element name="RecodeLeaveFieldAsIs">
  98. <short>Bitmask deciding what to do with each TDateTime field in recode routines</short>
  99. </element>
  100. <!-- constant Visibility: default -->
  101. <element name="ApproxDaysPerMonth">
  102. <short>Average number of days in a month, measured over a year. Used in <link id="MonthsBetween"/>.</short>
  103. </element>
  104. <!-- constant Visibility: default -->
  105. <element name="ApproxDaysPerYear">
  106. <short>Average number of days in a year, measured over 4 years. Used in <link id="YearsBetween"/>.</short>
  107. </element>
  108. <!-- function Visibility: default -->
  109. <element name="DateOf">
  110. <short>Extract the date part from a DateTime indication.</short>
  111. <descr>
  112. <p>
  113. <var>DateOf</var> extracts the date part from <var>AValue</var> and returns
  114. the result.
  115. </p>
  116. <p>
  117. Since the <var>TDateTime</var> is actually a double with the date part
  118. encoded in the integer part, this operation corresponds to a call to
  119. <var>Trunc</var>.
  120. </p>
  121. </descr>
  122. <seealso>
  123. <link id="TimeOf"/>
  124. <link id="YearOf"/>
  125. <link id="MonthOf"/>
  126. <link id="DayOf"/>
  127. <link id="HourOf"/>
  128. <link id="MinuteOf"/>
  129. <link id="SecondOf"/>
  130. <link id="MilliSecondOf"/>
  131. </seealso>
  132. <example file="datutex/ex1"/>
  133. </element>
  134. <!-- function result Visibility: default -->
  135. <element name="DateOf.Result">
  136. <short>Date part of <var>AValue</var>.</short>
  137. </element>
  138. <!-- argument Visibility: default -->
  139. <element name="DateOf.AValue">
  140. <short>Datetime to extract date from</short>
  141. </element>
  142. <!-- function Visibility: default -->
  143. <element name="TimeOf">
  144. <short>Extract the time part from a DateTime indication.</short>
  145. <descr>
  146. <p>
  147. <var>TimeOf</var> extracts the time part from <var>AValue</var> and returns
  148. the result.
  149. </p>
  150. <p>
  151. Since the <var>TDateTime</var> is actually a double with the time part
  152. encoded in the fractional part, this operation corresponds to a call to
  153. <var>Frac</var>.
  154. </p>
  155. </descr>
  156. <seealso>
  157. <link id="DateOf"/>
  158. <link id="YearOf"/>
  159. <link id="MonthOf"/>
  160. <link id="DayOf"/>
  161. <link id="HourOf"/>
  162. <link id="MinuteOf"/>
  163. <link id="SecondOf"/>
  164. <link id="MilliSecondOf"/>
  165. </seealso>
  166. <example file="datutex/ex2"/>
  167. </element>
  168. <!-- function result Visibility: default -->
  169. <element name="TimeOf.Result">
  170. <short>Time part of <var>AValue</var>.</short>
  171. </element>
  172. <!-- argument Visibility: default -->
  173. <element name="TimeOf.AValue">
  174. <short>Datetime to extract time from</short>
  175. </element>
  176. <!-- function Visibility: default -->
  177. <element name="IsInLeapYear">
  178. <short>Determine whether a date is in a leap year.</short>
  179. <descr>
  180. <var>IsInLeapYear</var> returns <var>True</var> if the year part of <var>AValue</var>
  181. is leap year, or <var>False</var> if not.
  182. </descr>
  183. <seealso>
  184. <link id="YearOf"/>
  185. <link id="IsPM"/>
  186. <link id="IsToday"/>
  187. <link id="IsSameDay"/>
  188. </seealso>
  189. <example file="datutex/ex3"/>
  190. </element>
  191. <!-- function result Visibility: default -->
  192. <element name="IsInLeapYear.Result">
  193. <short><var>True</var> if <var>AValue</var> is in a leap year, <var>False</var> if not.</short>
  194. </element>
  195. <!-- argument Visibility: default -->
  196. <element name="IsInLeapYear.AValue">
  197. <short>Date to be checked.</short>
  198. </element>
  199. <!-- function Visibility: default -->
  200. <element name="IsPM">
  201. <short>Determine whether a time is PM or AM.</short>
  202. <descr>
  203. <var>IsPM</var> returns <var>True</var> if the time part of
  204. <var>AValue</var> is later then 12:00 (PM, or afternoon).
  205. </descr>
  206. <seealso>
  207. <link id="YearOf"/>
  208. <link id="IsInLeapYear"/>
  209. <link id="IsToday"/>
  210. <link id="IsSameDay"/>
  211. </seealso>
  212. <example file="datutex/ex4"/>
  213. </element>
  214. <!-- function result Visibility: default -->
  215. <element name="IsPM.Result">
  216. <short><var>True</var> if the time part of <var>AValue</var> is PM (afternoon).</short>
  217. </element>
  218. <!-- argument Visibility: default -->
  219. <element name="IsPM.AValue">
  220. <short>Time to check.</short>
  221. </element>
  222. <!-- function Visibility: default -->
  223. <element name="IsValidDate">
  224. <short>Check whether a set of values is a valid date indication.</short>
  225. <descr>
  226. <p>
  227. <var>IsValidDate</var> returns <var>True</var> when the values <var>AYear</var>,
  228. <var>AMonth</var>, <var>ADay</var> form a valid date indication. If one of
  229. the values is not valid (e.g. the day is invalid or does not exist in that
  230. particular month), <var>False</var> is returned.
  231. </p>
  232. <p>
  233. <var>AYear</var> must be in the range 1..9999 to be valid.
  234. </p>
  235. </descr>
  236. <example file="datutex/ex5"/>
  237. <seealso>
  238. <link id="IsValidTime"/>
  239. <link id="IsValidDateTime"/>
  240. <link id="IsValidDateDay"/>
  241. <link id="IsValidDateWeek"/>
  242. <link id="IsValidDateMonthWeek"/>
  243. </seealso>
  244. </element>
  245. <!-- function result Visibility: default -->
  246. <element name="IsValidDate.Result">
  247. <short><var>True</var> if the given values form a valid date, <var>False</var> if not. </short>
  248. </element>
  249. <!-- argument Visibility: default -->
  250. <element name="IsValidDate.AYear">
  251. <short>Year value</short>
  252. </element>
  253. <!-- argument Visibility: default -->
  254. <element name="IsValidDate.AMonth">
  255. <short>Month in the year</short>
  256. </element>
  257. <!-- argument Visibility: default -->
  258. <element name="IsValidDate.ADay">
  259. <short>Day in the month</short>
  260. </element>
  261. <!-- function Visibility: default -->
  262. <element name="IsValidTime">
  263. <short>Check whether a set of values is a valid time indication.</short>
  264. <descr/>
  265. </element>
  266. <!-- function result Visibility: default -->
  267. <element name="IsValidTime.Result">
  268. <short><var>True</var> if the given values form a valid time, <var>False</var> if not.</short>
  269. <descr>
  270. <var>IsValidTime</var> returns <var>True</var> when the values
  271. <var>AHour</var>,
  272. <var>AMinute</var>, <var>ASecond</var> and <var>AMilliSecond</var> form a valid
  273. time indication. If one of the values is not valid (e.g. the seconds are
  274. larger than 60), <var>False</var> is returned.
  275. </descr>
  276. <example file="datutex/ex6"/>
  277. <seealso>
  278. <link id="IsValidDate"/>
  279. <link id="IsValidDateTime"/>
  280. <link id="IsValidDateDay"/>
  281. <link id="IsValidDateWeek"/>
  282. <link id="IsValidDateMonthWeek"/>
  283. </seealso>
  284. </element>
  285. <!-- argument Visibility: default -->
  286. <element name="IsValidTime.AHour">
  287. <short>Hour of the day.</short>
  288. </element>
  289. <!-- argument Visibility: default -->
  290. <element name="IsValidTime.AMinute">
  291. <short>Minute in the hour</short>
  292. </element>
  293. <!-- argument Visibility: default -->
  294. <element name="IsValidTime.ASecond">
  295. <short>Second in the minute</short>
  296. </element>
  297. <!-- argument Visibility: default -->
  298. <element name="IsValidTime.AMilliSecond">
  299. <short>Milliseconds in the second</short>
  300. </element>
  301. <!-- function Visibility: default -->
  302. <element name="IsValidDateTime">
  303. <short>Check whether a set of values is a valid date and time indication.</short>
  304. <descr>
  305. <p>
  306. <var>IsValidTime</var> returns <var>True</var> when the values
  307. <var>AYear</var>, <var>AMonth</var>, <var>ADay</var>,
  308. <var>AHour</var>, <var>AMinute</var>, <var>ASecond</var>
  309. and <var>AMilliSecond</var> form a valid date and time indication.
  310. If one of the values is not valid (e.g. the seconds are larger than 60), <var>False</var> is returned.
  311. </p>
  312. <p>
  313. <var>AYear</var> must be in the range 1..9999 to be valid.
  314. </p>
  315. </descr>
  316. <example file="datutex/ex7"/>
  317. <seealso>
  318. <link id="IsValidDate"/>
  319. <link id="IsValidTime"/>
  320. <link id="IsValidDateDay"/>
  321. <link id="IsValidDateWeek"/>
  322. <link id="IsValidDateMonthWeek"/>
  323. </seealso>
  324. </element>
  325. <!-- function result Visibility: default -->
  326. <element name="IsValidDateTime.Result">
  327. <short><var>True</var> if the given values form a valid date/time pair, <var>False</var> if not.</short>
  328. </element>
  329. <!-- argument Visibility: default -->
  330. <element name="IsValidDateTime.AYear">
  331. <short>Year value</short>
  332. </element>
  333. <!-- argument Visibility: default -->
  334. <element name="IsValidDateTime.AMonth">
  335. <short>Month in the year</short>
  336. </element>
  337. <!-- argument Visibility: default -->
  338. <element name="IsValidDateTime.ADay">
  339. <short>Day in the month</short>
  340. </element>
  341. <!-- argument Visibility: default -->
  342. <element name="IsValidDateTime.AHour">
  343. <short>Hour of the day</short>
  344. </element>
  345. <!-- argument Visibility: default -->
  346. <element name="IsValidDateTime.AMinute">
  347. <short>Minute in the hour</short>
  348. </element>
  349. <!-- argument Visibility: default -->
  350. <element name="IsValidDateTime.ASecond">
  351. <short>Second in the minute</short>
  352. </element>
  353. <!-- argument Visibility: default -->
  354. <element name="IsValidDateTime.AMilliSecond">
  355. <short>Milliseconds in the second</short>
  356. </element>
  357. <!-- function Visibility: default -->
  358. <element name="IsValidDateDay">
  359. <short>Check whether a given year/day of year combination is a valid date.</short>
  360. <descr>
  361. <p>
  362. <var>IsValidDateDay</var> returns <var>True</var> if <var>AYear</var> and
  363. <var>ADayOfYear</var> form a valid date indication, or <var>False</var>
  364. otherwise.
  365. </p>
  366. <p>
  367. <var>AYear</var> must be in the range 1..9999 to be valid.
  368. </p>
  369. <p>
  370. The <var>ADayOfYear</var> value is checked to see whether it falls within the valid range of
  371. dates for <var>AYear</var>.
  372. </p>
  373. </descr>
  374. <example file="datutex/ex9"/>
  375. <seealso>
  376. <link id="IsValidDate"/>
  377. <link id="IsValidTime"/>
  378. <link id="IsValidDateTime"/>
  379. <link id="IsValidDateWeek"/>
  380. <link id="IsValidDateMonthWeek"/>
  381. </seealso>
  382. </element>
  383. <!-- function result Visibility: default -->
  384. <element name="IsValidDateDay.Result">
  385. <short><var>True</var> if the given combination is a valid date, <var>False</var> otherwise.</short>
  386. </element>
  387. <!-- argument Visibility: default -->
  388. <element name="IsValidDateDay.AYear">
  389. <short>Year</short>
  390. </element>
  391. <!-- argument Visibility: default -->
  392. <element name="IsValidDateDay.ADayOfYear">
  393. <short>Day in the year</short>
  394. </element>
  395. <!-- function Visibility: default -->
  396. <element name="IsValidDateWeek">
  397. <short>Check whether a given year/week/day of the week combination is a valid day.</short>
  398. <descr>
  399. <p>
  400. <var>IsValidDateWeek</var> returns <var>True</var> if <var>AYear</var>,
  401. <var>AWeekOfYear</var> and <var>ADayOfWeek</var> form a valid date indication,
  402. or <var>False</var> otherwise.
  403. </p>
  404. <p>
  405. <var>AYear</var> must be in the range 1..9999 to be valid.
  406. </p>
  407. <p>
  408. The <var>ADayOfWeek</var>,<var>ADayOfWeek</var> values are checked to see whether
  409. the combination falls within the valid range of weeks for <var>AYear</var>.
  410. </p>
  411. </descr>
  412. <example file="datutex/ex10"/>
  413. <seealso>
  414. <link id="IsValidDate"/>
  415. <link id="IsValidTime"/>
  416. <link id="IsValidDateTime"/>
  417. <link id="IsValidDateDay"/>
  418. <link id="IsValidDateMonthWeek"/>
  419. </seealso>
  420. </element>
  421. <!-- function result Visibility: default -->
  422. <element name="IsValidDateWeek.Result">
  423. <short><var>True</var> if the given combination is a valid date, <var>False</var> otherwise.</short>
  424. </element>
  425. <!-- argument Visibility: default -->
  426. <element name="IsValidDateWeek.AYear">
  427. <short>Year</short>
  428. </element>
  429. <!-- argument Visibility: default -->
  430. <element name="IsValidDateWeek.AWeekOfYear">
  431. <short>Week in the year</short>
  432. </element>
  433. <!-- argument Visibility: default -->
  434. <element name="IsValidDateWeek.ADayOfWeek">
  435. <short>Day in the week</short>
  436. </element>
  437. <!-- function Visibility: default -->
  438. <element name="IsValidDateMonthWeek">
  439. <short>Check whether a given year/month/week/day of the week combination is a valid day</short>
  440. <descr>
  441. <p>
  442. <var>IsValidDateMonthWeek</var> returns <var>True</var> if <var>AYear</var>,
  443. <var>AMonth</var> <var>AWeekOfMonth</var> and <var>ADayOfWeek</var> form a valid date indication,
  444. or <var>False</var> otherwise.
  445. </p>
  446. <p>
  447. <var>AYear</var> must be in the range 1..9999 to be valid.
  448. </p>
  449. <p>
  450. The <var>AWeekOfMonth</var>,<var>ADayOfWeek</var> values are checked to see whether
  451. the combination falls within the valid range of weeks for the
  452. <var>AYear</var>,<var>AMonth</var> combination.
  453. </p>
  454. </descr>
  455. <example file="datutex/ex11"/>
  456. <seealso>
  457. <link id="IsValidDate"/>
  458. <link id="IsValidTime"/>
  459. <link id="IsValidDateTime"/>
  460. <link id="IsValidDateDay"/>
  461. <link id="IsValidDateWeek"/>
  462. </seealso>
  463. </element>
  464. <!-- function result Visibility: default -->
  465. <element name="IsValidDateMonthWeek.Result">
  466. <short><var>True</var> if the given combination is a valid date, <var>False</var> otherwise.</short>
  467. </element>
  468. <!-- argument Visibility: default -->
  469. <element name="IsValidDateMonthWeek.AYear">
  470. <short>Year</short>
  471. </element>
  472. <!-- argument Visibility: default -->
  473. <element name="IsValidDateMonthWeek.AMonth">
  474. <short>Month of the year</short>
  475. </element>
  476. <!-- argument Visibility: default -->
  477. <element name="IsValidDateMonthWeek.AWeekOfMonth">
  478. <short>Week of the month.</short>
  479. </element>
  480. <!-- argument Visibility: default -->
  481. <element name="IsValidDateMonthWeek.ADayOfWeek">
  482. <short>Day in the week.</short>
  483. </element>
  484. <!-- function Visibility: default -->
  485. <element name="WeeksInYear">
  486. <short>return the number of weeks in the year, given a date</short>
  487. <descr>
  488. <p>
  489. <var>WeeksInYear</var> returns the number of weeks in the year part of
  490. <var>AValue</var>. The return value is either 52 or 53.
  491. </p>
  492. <remark>
  493. The first week of the year is determined according to the ISO 8601 standard:
  494. It is the first week that has at least 4 days in it, i.e. it includes a
  495. thursday.
  496. </remark>
  497. </descr>
  498. <seealso>
  499. <link id="WeeksInAYear"/>
  500. <link id="DaysInYear"/>
  501. <link id="DaysInAYear"/>
  502. <link id="DaysInMonth"/>
  503. <link id="DaysInAMonth"/>
  504. </seealso>
  505. <example file="datutex/ex12"/>
  506. </element>
  507. <!-- function result Visibility: default -->
  508. <element name="WeeksInYear.Result">
  509. <short>Number of weeks.</short>
  510. </element>
  511. <!-- argument Visibility: default -->
  512. <element name="WeeksInYear.AValue">
  513. <short>Day in the year.</short>
  514. </element>
  515. <!-- function Visibility: default -->
  516. <element name="WeeksInAYear">
  517. <short>Return the number of weeks in a given year</short>
  518. <descr>
  519. <p>
  520. <var>WeeksInAYear</var> returns the number of weeks in the year
  521. <var>AYear</var>. The return value is either 52 or 53.
  522. </p>
  523. <remark>
  524. The first week of the year is determined according to the ISO 8601 standard:
  525. It is the first week that has at least 4 days in it, i.e. it includes a
  526. thursday.
  527. </remark>
  528. </descr>
  529. <seealso>
  530. <link id="WeeksInYear"/>
  531. <link id="DaysInYear"/>
  532. <link id="DaysInAYear"/>
  533. <link id="DaysInMonth"/>
  534. <link id="DaysInAMonth"/>
  535. </seealso>
  536. <example file="datutex/ex13"/>
  537. </element>
  538. <!-- function result Visibility: default -->
  539. <element name="WeeksInAYear.Result">
  540. <short>Number of weeks in <var>AYear</var></short>
  541. </element>
  542. <!-- argument Visibility: default -->
  543. <element name="WeeksInAYear.AYear">
  544. <short>A (valid) year.</short>
  545. </element>
  546. <!-- function Visibility: default -->
  547. <element name="DaysInYear">
  548. <short>Return the number of days in the year in which a date occurs.</short>
  549. <descr>
  550. <p>
  551. <var>daysInYear</var> returns the number of days in the year part of
  552. <var>AValue</var>. The return value is either 365 or 366.
  553. </p>
  554. </descr>
  555. <seealso>
  556. <link id="WeeksInAYear"/>
  557. <link id="WeeksInYear"/>
  558. <link id="DaysInAYear"/>
  559. <link id="DaysInMonth"/>
  560. <link id="DaysInAMonth"/>
  561. </seealso>
  562. <example file="datutex/ex14"/>
  563. </element>
  564. <!-- function result Visibility: default -->
  565. <element name="DaysInYear.Result">
  566. <short>Number of days in the year in which <var>AValue</var> occurs.</short>
  567. </element>
  568. <!-- argument Visibility: default -->
  569. <element name="DaysInYear.AValue">
  570. <short>Date in year of which to calculate the number of days.</short>
  571. </element>
  572. <!-- function Visibility: default -->
  573. <element name="DaysInAYear">
  574. <short>Number of days in a particular year.</short>
  575. <descr>
  576. <p>
  577. <var>DaysInAYear</var> returns the number of weeks in the year
  578. <var>AYear</var>. The return value is either 365 or 366.
  579. </p>
  580. </descr>
  581. <seealso>
  582. <link id="WeeksInAYear"/>
  583. <link id="WeeksInYear"/>
  584. <link id="DaysInYear"/>
  585. <link id="DaysInMonth"/>
  586. <link id="DaysInAMonth"/>
  587. </seealso>
  588. <example file="datutex/ex15"/>
  589. </element>
  590. <!-- function result Visibility: default -->
  591. <element name="DaysInAYear.Result">
  592. <short>Number of days in year <var>AYear</var>.</short>
  593. </element>
  594. <!-- argument Visibility: default -->
  595. <element name="DaysInAYear.AYear">
  596. <short>Year to return the number of days from</short>
  597. </element>
  598. <!-- function Visibility: default -->
  599. <element name="DaysInMonth">
  600. <short>Return the number of days in the month in which a date occurs.</short>
  601. <descr>
  602. <p>
  603. <var>DaysInMonth</var> returns the number of days in the month in which
  604. <var>AValue</var> falls. The return value takes leap years into account.
  605. </p>
  606. </descr>
  607. <seealso>
  608. <link id="WeeksInAYear"/>
  609. <link id="WeeksInYear"/>
  610. <link id="DaysInYear"/>
  611. <link id="DaysInAYear"/>
  612. <link id="DaysInAMonth"/>
  613. </seealso>
  614. <example file="datutex/ex16"/>
  615. </element>
  616. <!-- function result Visibility: default -->
  617. <element name="DaysInMonth.Result">
  618. <short>Number of days in the month in which <var>AValue</var> occurs.</short>
  619. </element>
  620. <!-- argument Visibility: default -->
  621. <element name="DaysInMonth.AValue">
  622. <short>Date in month of which to calculate the number of days.</short>
  623. </element>
  624. <!-- function Visibility: default -->
  625. <element name="DaysInAMonth">
  626. <short>Number of days in a month of a certain year.</short>
  627. <descr>
  628. <p>
  629. <var>DaysInYMonth</var> returns the number of days in the month
  630. <var>AMonth</var> in the year<var>AYear</var>.
  631. The return value takes leap years into account.
  632. </p>
  633. </descr>
  634. <seealso>
  635. <link id="WeeksInAYear"/>
  636. <link id="WeeksInYear"/>
  637. <link id="DaysInYear"/>
  638. <link id="DaysInAYear"/>
  639. <link id="DaysInMonth"/>
  640. </seealso>
  641. <example file="datutex/ex17"/>
  642. </element>
  643. <!-- function result Visibility: default -->
  644. <element name="DaysInAMonth.Result">
  645. <short>The number of days in month <var>AMonth</var>, in year <var>AYear</var>.</short>
  646. </element>
  647. <!-- argument Visibility: default -->
  648. <element name="DaysInAMonth.AYear">
  649. <short>Year in which the month occurs.</short>
  650. </element>
  651. <!-- argument Visibility: default -->
  652. <element name="DaysInAMonth.AMonth">
  653. <short>Month of which the number of days should be returned.</short>
  654. </element>
  655. <!-- function Visibility: default -->
  656. <element name="Today">
  657. <short>Return the current date</short>
  658. <descr>
  659. <p>
  660. <var>Today</var> is an alias for the <link
  661. id="#rtl.sysutils.Date">Date</link> function in the <link
  662. id="#rtl.sysutils">sysutils</link> unit.
  663. </p>
  664. <p>
  665. For an example, see <link id="Yesterday"/>
  666. </p>
  667. </descr>
  668. <seealso>
  669. <link id="#rtl.sysutils.Date">Date</link>
  670. <link id="Yesterday"/>
  671. <link id="Tomorrow"/>
  672. </seealso>
  673. </element>
  674. <!-- function result Visibility: default -->
  675. <element name="Today.Result">
  676. <short>Current day as <var>TDateTime</var>.</short>
  677. </element>
  678. <!-- function Visibility: default -->
  679. <element name="Yesterday">
  680. <short>Return the previous day.</short>
  681. <descr>
  682. <var>Yesterday</var> returns yesterday's date. Yesterday is determined from
  683. the system clock, i.e. it is <link id="Today"/> -1.
  684. </descr>
  685. <seealso>
  686. <link id="Today"/>
  687. <link id="Tomorrow"/>
  688. </seealso>
  689. <example file="datutex/ex18"/>
  690. </element>
  691. <!-- function result Visibility: default -->
  692. <element name="Yesterday.Result">
  693. <short>Previous day as <var>TDateTime</var>.</short>
  694. </element>
  695. <!-- function Visibility: default -->
  696. <element name="Tomorrow">
  697. <short>Return the next day</short>
  698. <descr>
  699. <var>Tomorrow</var> returns tomorrow's date. Tomorrow is determined from
  700. the system clock, i.e. it is <link id="Today"/> +1.
  701. </descr>
  702. <seealso>
  703. <link id="Today"/>
  704. <link id="Yesterday"/>
  705. </seealso>
  706. <example file="datutex/ex19"/>
  707. </element>
  708. <!-- function result Visibility: default -->
  709. <element name="Tomorrow.Result">
  710. <short>Next day as <var>TDateTime</var>.</short>
  711. </element>
  712. <!-- function Visibility: default -->
  713. <element name="IsToday">
  714. <short>Check whether a given date is today.</short>
  715. <descr>
  716. <var>IsToday</var> returns <var>True</var> if <var>AValue</var> is today's
  717. date, and <var>False</var> otherwise.
  718. </descr>
  719. <seealso>
  720. <link id="Today"/>
  721. <link id="Yesterday"/>
  722. <link id="Tomorrow"/>
  723. <link id="IsSameDay"/>
  724. </seealso>
  725. <example file="datutex/ex20"/>
  726. </element>
  727. <!-- function result Visibility: default -->
  728. <element name="IsToday.Result">
  729. <short><var>True</var> if <var>AValue</var> is today, <var>False</var> otherwise.</short>
  730. </element>
  731. <!-- argument Visibility: default -->
  732. <element name="IsToday.AValue">
  733. <short>Date to check, may contain a time part.</short>
  734. </element>
  735. <!-- function Visibility: default -->
  736. <element name="IsSameDay">
  737. <short>Check if two date/time indications are the same day.</short>
  738. <descr>
  739. <var>IsSameDay</var> checks whether <var>AValue</var> and <var>ABasis</var>
  740. have the same date part, and returns <var>True</var> if they do,
  741. <var>False</var> if not.
  742. </descr>
  743. <seealso>
  744. <link id="Today"/>
  745. <link id="Yesterday"/>
  746. <link id="Tomorrow"/>
  747. <link id="IsToday"/>
  748. </seealso>
  749. <example file="datutex/ex21"/>
  750. </element>
  751. <!-- function result Visibility: default -->
  752. <element name="IsSameDay.Result">
  753. <short><var>True</var> if <var>AValue</var> and <var>ABasis</var> are on the same
  754. day, <var>False</var> otherwise..</short>
  755. </element>
  756. <!-- argument Visibility: default -->
  757. <element name="IsSameDay.AValue">
  758. <short>First date/time</short>
  759. </element>
  760. <!-- argument Visibility: default -->
  761. <element name="IsSameDay.ABasis">
  762. <short>Second date/time</short>
  763. </element>
  764. <!-- function Visibility: default -->
  765. <element name="PreviousDayOfWeek">
  766. <short>Given a day of the week, return the previous day of the week.</short>
  767. <descr>
  768. <p>
  769. <var>PreviousDayOfWeek</var> returns the previous day of the week. If the
  770. current day is the first day of the week (1) then the last day will be
  771. returned (7).
  772. </p>
  773. <remark>
  774. Note that the days of the week are in ISO notation, i.e. 1-based.
  775. </remark>
  776. </descr>
  777. <seealso>
  778. <link id="Yesterday"/>
  779. </seealso>
  780. <example file="datutex/ex22"/>
  781. </element>
  782. <!-- function result Visibility: default -->
  783. <element name="PreviousDayOfWeek.Result">
  784. <short>The day of the week prior to <var>DayOfWeek</var></short>
  785. </element>
  786. <!-- argument Visibility: default -->
  787. <element name="PreviousDayOfWeek.DayOfWeek">
  788. <short>Day of the week.</short>
  789. </element>
  790. <!-- function Visibility: default -->
  791. <element name="YearOf">
  792. <short>Extract the year from a given date.</short>
  793. <descr>
  794. <var>YearOf</var> returns the year part of the <var>AValue</var> date/time
  795. indication. It is a number between 1 and 9999.
  796. </descr>
  797. <seealso>
  798. <link id="MonthOf"/>
  799. <link id="DayOf"/>
  800. <link id="WeekOf"/>
  801. <link id="HourOf"/>
  802. <link id="MinuteOf"/>
  803. <link id="SecondOf"/>
  804. <link id="MilliSecondOf"/>
  805. </seealso>
  806. <example file="datutex/ex23"/>
  807. </element>
  808. <!-- function result Visibility: default -->
  809. <element name="YearOf.Result">
  810. <short>Year part of <var>AValue</var></short>
  811. <descr/>
  812. </element>
  813. <!-- argument Visibility: default -->
  814. <element name="YearOf.AValue">
  815. <short>Date to extract year from.</short>
  816. </element>
  817. <!-- function Visibility: default -->
  818. <element name="MonthOf">
  819. <short>Extract the month from a given date.</short>
  820. <descr>
  821. <p>
  822. <var>MonthOf</var> returns the month part of the <var>AValue</var> date/time
  823. indication. It is a number between 1 and 12.
  824. </p>
  825. <p>
  826. For an example, see <link id="YearOf"/>
  827. </p>
  828. </descr>
  829. <seealso>
  830. <link id="YearOf"/>
  831. <link id="DayOf"/>
  832. <link id="WeekOf"/>
  833. <link id="HourOf"/>
  834. <link id="MinuteOf"/>
  835. <link id="SecondOf"/>
  836. <link id="MilliSecondOf"/>
  837. </seealso>
  838. </element>
  839. <!-- function result Visibility: default -->
  840. <element name="MonthOf.Result">
  841. <short>Month part of <var>AValue</var></short>
  842. </element>
  843. <!-- argument Visibility: default -->
  844. <element name="MonthOf.AValue">
  845. <short>Date to extract month from.</short>
  846. </element>
  847. <!-- function Visibility: default -->
  848. <element name="WeekOf">
  849. <short>Extract week (of the year) from a given date.</short>
  850. <descr>
  851. <p>
  852. <var>WeekOf</var> returns the week-of-the-year part of the <var>AValue</var> date/time
  853. indication. It is a number between 1 and 53.
  854. </p>
  855. <p>
  856. For an example, see <link id="YearOf"/>
  857. </p>
  858. </descr>
  859. <seealso>
  860. <link id="YearOf"/>
  861. <link id="DayOf"/>
  862. <link id="MonthOf"/>
  863. <link id="HourOf"/>
  864. <link id="MinuteOf"/>
  865. <link id="SecondOf"/>
  866. <link id="MilliSecondOf"/>
  867. </seealso>
  868. </element>
  869. <!-- function result Visibility: default -->
  870. <element name="WeekOf.Result">
  871. <short>Week part of <var>AValue</var>.</short>
  872. </element>
  873. <!-- argument Visibility: default -->
  874. <element name="WeekOf.AValue">
  875. <short>Date to extract week from.</short>
  876. </element>
  877. <!-- function Visibility: default -->
  878. <element name="DayOf">
  879. <short>Extract the day (of month) part from a DateTime value</short>
  880. <descr>
  881. <p>
  882. <var>DayOf</var> returns the day of the month part of the <var>AValue</var> date/time
  883. indication. It is a number between 1 and 31.
  884. </p>
  885. <p>
  886. For an example, see <link id="YearOf"/>
  887. </p>
  888. </descr>
  889. <seealso>
  890. <link id="YearOf"/>
  891. <link id="WeekOf"/>
  892. <link id="MonthOf"/>
  893. <link id="HourOf"/>
  894. <link id="MinuteOf"/>
  895. <link id="SecondOf"/>
  896. <link id="MilliSecondOf"/>
  897. </seealso>
  898. </element>
  899. <!-- function result Visibility: default -->
  900. <element name="DayOf.Result">
  901. <short>Day of month part of <var>AValue</var>.</short>
  902. </element>
  903. <!-- argument Visibility: default -->
  904. <element name="DayOf.AValue">
  905. <short>Date to extract day of.</short>
  906. </element>
  907. <!-- function Visibility: default -->
  908. <element name="HourOf">
  909. <short>Extract the hour part from a DateTime value.</short>
  910. <descr>
  911. <p>
  912. <var>HourOf</var> returns the hour of the day part of the <var>AValue</var> date/time
  913. indication. It is a number between 0 and 23.
  914. </p>
  915. <p>
  916. For an example, see <link id="YearOf"/>
  917. </p>
  918. </descr>
  919. <seealso>
  920. <link id="YearOf"/>
  921. <link id="WeekOf"/>
  922. <link id="MonthOf"/>
  923. <link id="DayOf"/>
  924. <link id="MinuteOf"/>
  925. <link id="SecondOf"/>
  926. <link id="MilliSecondOf"/>
  927. </seealso>
  928. </element>
  929. <!-- function result Visibility: default -->
  930. <element name="HourOf.Result">
  931. <short>Hour part of <var>AValue</var>.</short>
  932. </element>
  933. <!-- argument Visibility: default -->
  934. <element name="HourOf.AValue">
  935. <short>Date/time value to extract hour from.</short>
  936. </element>
  937. <!-- function Visibility: default -->
  938. <element name="MinuteOf">
  939. <short>Extract the minute part from a DateTime value.</short>
  940. <descr>
  941. <p>
  942. <var>MinuteOf</var> returns the minute of the hour part of the <var>AValue</var> date/time
  943. indication. It is a number between 0 and 59.
  944. </p>
  945. <p>
  946. For an example, see <link id="YearOf"/>
  947. </p>
  948. </descr>
  949. <seealso>
  950. <link id="YearOf"/>
  951. <link id="WeekOf"/>
  952. <link id="MonthOf"/>
  953. <link id="DayOf"/>
  954. <link id="HourOf"/>
  955. <link id="SecondOf"/>
  956. <link id="MilliSecondOf"/>
  957. </seealso>
  958. </element>
  959. <!-- function result Visibility: default -->
  960. <element name="MinuteOf.Result">
  961. <short>Minute part of <var>AValue</var>.</short>
  962. </element>
  963. <!-- argument Visibility: default -->
  964. <element name="MinuteOf.AValue">
  965. <short>Date/time value to extract minute from.</short>
  966. </element>
  967. <!-- function Visibility: default -->
  968. <element name="SecondOf">
  969. <short>Extract the second part from a DateTime value.</short>
  970. <descr>
  971. <p>
  972. <var>SecondOf</var> returns the second of the minute part of the <var>AValue</var> date/time
  973. indication. It is a number between 0 and 59.
  974. </p>
  975. <p>
  976. For an example, see <link id="YearOf"/>
  977. </p>
  978. </descr>
  979. <seealso>
  980. <link id="YearOf"/>
  981. <link id="WeekOf"/>
  982. <link id="MonthOf"/>
  983. <link id="DayOf"/>
  984. <link id="HourOf"/>
  985. <link id="MinuteOf"/>
  986. <link id="MilliSecondOf"/>
  987. </seealso>
  988. </element>
  989. <!-- function result Visibility: default -->
  990. <element name="SecondOf.Result">
  991. <short>Second part of <var>AValue</var>.</short>
  992. </element>
  993. <!-- argument Visibility: default -->
  994. <element name="SecondOf.AValue">
  995. <short>Date/time value to extract second from.</short>
  996. </element>
  997. <!-- function Visibility: default -->
  998. <element name="MilliSecondOf">
  999. <short>Extract the millisecond part from a DateTime value.</short>
  1000. <descr>
  1001. <p>
  1002. <var>MillisecondOf</var> returns the second of the minute part of the <var>AValue</var> date/time
  1003. indication. It is a number between 0 and 999.
  1004. </p>
  1005. <p>
  1006. For an example, see <link id="YearOf"/>
  1007. </p>
  1008. </descr>
  1009. <seealso>
  1010. <link id="YearOf"/>
  1011. <link id="WeekOf"/>
  1012. <link id="MonthOf"/>
  1013. <link id="DayOf"/>
  1014. <link id="HourOf"/>
  1015. <link id="MinuteOf"/>
  1016. <link id="MilliSecondOf"/>
  1017. </seealso>
  1018. </element>
  1019. <!-- function result Visibility: default -->
  1020. <element name="MilliSecondOf.Result">
  1021. <short>Millisecond part of <var>AValue</var>.</short>
  1022. </element>
  1023. <!-- argument Visibility: default -->
  1024. <element name="MilliSecondOf.AValue">
  1025. <short>Date/time value to extract millisecond from.</short>
  1026. </element>
  1027. <!-- function Visibility: default -->
  1028. <element name="StartOfTheYear">
  1029. <short>Return the first day of the year, given a date in this year.</short>
  1030. <descr>
  1031. <var>StartOfTheYear</var> extracts the year part of <var>AValue</var> and
  1032. returns a <var>TDateTime</var> value with the date of the first day of that year (January 1), as the
  1033. <link id="StartOfAYear"/> function.
  1034. </descr>
  1035. <seealso>
  1036. <link id="StartOfAYear"/>
  1037. <link id="EndOfTheYear"/>
  1038. <link id="EndOfAYear"/>
  1039. </seealso>
  1040. <example file="datutex/ex24"/>
  1041. </element>
  1042. <!-- function result Visibility: default -->
  1043. <element name="StartOfTheYear.Result">
  1044. <short>First day of the year as a <var>TDateTime</var> value.</short>
  1045. <descr/>
  1046. </element>
  1047. <!-- argument Visibility: default -->
  1048. <element name="StartOfTheYear.AValue">
  1049. <short>Date in year of which to return the start </short>
  1050. <descr/>
  1051. </element>
  1052. <!-- function Visibility: default -->
  1053. <element name="EndOfTheYear">
  1054. <short>Calculate a DateTime value representing the last day of a year, given a date in that year.</short>
  1055. <descr>
  1056. <var>EndOfTheYear</var> extracts the year part of <var>AValue</var> and
  1057. returns a <var>TDateTime</var> value with the date of the last day of that year (December 31), as the
  1058. <link id="EndOfAYear"/> function.
  1059. </descr>
  1060. <seealso>
  1061. <link id="StartOfAYear"/>
  1062. <link id="StartOfTheYear"/>
  1063. <link id="EndOfAYear"/>
  1064. </seealso>
  1065. <example file="datutex/ex25"/>
  1066. </element>
  1067. <!-- function result Visibility: default -->
  1068. <element name="EndOfTheYear.Result">
  1069. <short>DateTime value representing the end of the year in which <var>AValue</var> falls.</short>
  1070. </element>
  1071. <!-- argument Visibility: default -->
  1072. <element name="EndOfTheYear.AValue">
  1073. <short>Date in the year of which the end should be calculated</short>
  1074. </element>
  1075. <!-- function Visibility: default -->
  1076. <element name="StartOfAYear">
  1077. <short>Return the first day of a given year.</short>
  1078. <descr>
  1079. <var>StartOfAYear</var> returns a <var>TDateTime</var> value with the date of the first day of the year <var>AYear</var> (January 1).
  1080. </descr>
  1081. <seealso>
  1082. <link id="StartOfTheYear"/>
  1083. <link id="EndOfTheYear"/>
  1084. <link id="EndOfAYear"/>
  1085. </seealso>
  1086. <example file="datutex/ex26"/>
  1087. </element>
  1088. <!-- function result Visibility: default -->
  1089. <element name="StartOfAYear.Result">
  1090. <short>First day of <var>AYear</var> as a <var>TDateTime</var></short>
  1091. </element>
  1092. <!-- argument Visibility: default -->
  1093. <element name="StartOfAYear.AYear">
  1094. <short>Year to get first date from.</short>
  1095. </element>
  1096. <!-- function Visibility: default -->
  1097. <element name="EndOfAYear">
  1098. <short>Calculate a DateTime value representing the last day of a year</short>
  1099. <descr>
  1100. <var>StartOfAYear</var>
  1101. returns a <var>TDateTime</var> value with the date of the last day of the year <var>AYear</var> (December 31).
  1102. </descr>
  1103. <seealso>
  1104. <link id="StartOfTheYear"/>
  1105. <link id="EndOfTheYear"/>
  1106. <link id="EndOfAYear"/>
  1107. </seealso>
  1108. <example file="datutex/ex27"/>
  1109. </element>
  1110. <!-- function result Visibility: default -->
  1111. <element name="EndOfAYear.Result">
  1112. <short>DateTime representing the last day of <var>AYear</var>.</short>
  1113. </element>
  1114. <!-- argument Visibility: default -->
  1115. <element name="EndOfAYear.AYear">
  1116. <short>Year to calculate last day from</short>
  1117. </element>
  1118. <!-- function Visibility: default -->
  1119. <element name="StartOfTheMonth">
  1120. <short>Calculate the first day of the month, given a date in that month.</short>
  1121. </element>
  1122. <!-- function result Visibility: default -->
  1123. <element name="StartOfTheMonth.Result">
  1124. <short>First day of month as a <var>TDateTime</var> value.</short>
  1125. </element>
  1126. <!-- argument Visibility: default -->
  1127. <element name="StartOfTheMonth.AValue">
  1128. <short>Date to return first of month from</short>
  1129. </element>
  1130. <!-- function Visibility: default -->
  1131. <element name="EndOfTheMonth">
  1132. <short>Calculate a DateTime value representing the last day of the month, given a day in that month.</short>
  1133. </element>
  1134. <!-- function result Visibility: default -->
  1135. <element name="EndOfTheMonth.Result">
  1136. <short>DateTime value representing the last day of the month in which <var>AVAlue</var> is a day.</short>
  1137. </element>
  1138. <!-- argument Visibility: default -->
  1139. <element name="EndOfTheMonth.AValue">
  1140. <short>Day in the month of which the last day should be returned.</short>
  1141. </element>
  1142. <!-- function Visibility: default -->
  1143. <element name="StartOfAMonth">
  1144. <short>Return first date of month, given a year/month pair.</short>
  1145. </element>
  1146. <!-- function result Visibility: default -->
  1147. <element name="StartOfAMonth.Result">
  1148. <short>First day of the month <var>AMonth</var> in <var>AYear</var></short>
  1149. </element>
  1150. <!-- argument Visibility: default -->
  1151. <element name="StartOfAMonth.AYear">
  1152. <short>A year.</short>
  1153. </element>
  1154. <!-- argument Visibility: default -->
  1155. <element name="StartOfAMonth.AMonth">
  1156. <short>Month in the year.</short>
  1157. </element>
  1158. <!-- function Visibility: default -->
  1159. <element name="EndOfAMonth">
  1160. <short>Calculate a datetime value representing the last day of the indicated month</short>
  1161. </element>
  1162. <!-- function result Visibility: default -->
  1163. <element name="EndOfAMonth.Result">
  1164. <short>DateTime value indicating the last day of <var>AMonth</var> in year <var>AYear</var>.</short>
  1165. </element>
  1166. <!-- argument Visibility: default -->
  1167. <element name="EndOfAMonth.AYear">
  1168. <short>Year in which month occurs</short>
  1169. </element>
  1170. <!-- argument Visibility: default -->
  1171. <element name="EndOfAMonth.AMonth">
  1172. <short>Month to calculate end of</short>
  1173. </element>
  1174. <!-- function Visibility: default -->
  1175. <element name="StartOfTheWeek">
  1176. <short>Return the first day of the week, given a date.</short>
  1177. </element>
  1178. <!-- function result Visibility: default -->
  1179. <element name="StartOfTheWeek.Result">
  1180. <short>First day of the week, in <var>TDateTime</var> format.</short>
  1181. </element>
  1182. <!-- argument Visibility: default -->
  1183. <element name="StartOfTheWeek.AValue">
  1184. <short>Day in the week.</short>
  1185. </element>
  1186. <!-- function Visibility: default -->
  1187. <element name="EndOfTheWeek">
  1188. <short>Calculate a DateTime value which represents the end of a week, given a date in that week.</short>
  1189. </element>
  1190. <!-- function result Visibility: default -->
  1191. <element name="EndOfTheWeek.Result">
  1192. <short>DateTime value representing the last day of the week in which <var>AVAlue</var> is a day.</short>
  1193. </element>
  1194. <!-- argument Visibility: default -->
  1195. <element name="EndOfTheWeek.AValue">
  1196. <short>Day in the week of which the last day should be calculated.</short>
  1197. </element>
  1198. <!-- function Visibility: default -->
  1199. <element name="StartOfAWeek">
  1200. <short>Return the first day of the week, given a year and a week in the year.</short>
  1201. </element>
  1202. <!-- function result Visibility: default -->
  1203. <element name="StartOfAWeek.Result">
  1204. <short>First day of the given week, in <var>TDateTime</var> format.</short>
  1205. </element>
  1206. <!-- argument Visibility: default -->
  1207. <element name="StartOfAWeek.AYear">
  1208. <short>Year</short>
  1209. </element>
  1210. <!-- argument Visibility: default -->
  1211. <element name="StartOfAWeek.AWeekOfYear">
  1212. <short>Week in the year</short>
  1213. </element>
  1214. <!-- argument Visibility: default -->
  1215. <element name="StartOfAWeek.ADayOfWeek">
  1216. <short>Day in the week (default 1)</short>
  1217. </element>
  1218. <!-- function Visibility: default -->
  1219. <element name="EndOfAWeek">
  1220. <short></short>
  1221. </element>
  1222. <!-- function result Visibility: default -->
  1223. <element name="EndOfAWeek.Result">
  1224. <short></short>
  1225. </element>
  1226. <!-- argument Visibility: default -->
  1227. <element name="EndOfAWeek.AYear">
  1228. <short></short>
  1229. </element>
  1230. <!-- argument Visibility: default -->
  1231. <element name="EndOfAWeek.AWeekOfYear">
  1232. <short></short>
  1233. </element>
  1234. <!-- argument Visibility: default -->
  1235. <element name="EndOfAWeek.ADayOfWeek">
  1236. <short>Day of the week</short>
  1237. </element>
  1238. <!-- function Visibility: default -->
  1239. <element name="EndOfAWeek">
  1240. <short>Calculate a datetime value which represents the end of a specified week.</short>
  1241. </element>
  1242. <!-- function result Visibility: default -->
  1243. <element name="EndOfAWeek.Result">
  1244. <short>DateTime value representing the end of the week specified by <var>AYear</var>, <var>AWeekOfYear</var> and <var>DayOfWeek</var></short>
  1245. </element>
  1246. <!-- argument Visibility: default -->
  1247. <element name="EndOfAWeek.AYear">
  1248. <short>Year</short>
  1249. </element>
  1250. <!-- argument Visibility: default -->
  1251. <element name="EndOfAWeek.AWeekOfYear">
  1252. <short>Week of the year</short>
  1253. </element>
  1254. <!-- function Visibility: default -->
  1255. <element name="StartOfTheDay">
  1256. <short>Calculate the start of the day as a DateTime value, given a moment in the day.</short>
  1257. </element>
  1258. <!-- function result Visibility: default -->
  1259. <element name="StartOfTheDay.Result">
  1260. <short>Start of the day (00:00) as DateTime value</short>
  1261. </element>
  1262. <!-- argument Visibility: default -->
  1263. <element name="StartOfTheDay.AValue">
  1264. <short>DateTime from which to calculate start of the day.</short>
  1265. </element>
  1266. <!-- function Visibility: default -->
  1267. <element name="EndOfTheDay">
  1268. <short>Calculate a datetime value that represents the end of a given day.</short>
  1269. </element>
  1270. <!-- function result Visibility: default -->
  1271. <element name="EndOfTheDay.Result">
  1272. <short>A datetime value representing the time 23:59:59.999 of the day <var>AValue</var>.</short>
  1273. </element>
  1274. <!-- argument Visibility: default -->
  1275. <element name="EndOfTheDay.AValue">
  1276. <short>Day to calculate the end of</short>
  1277. </element>
  1278. <!-- function Visibility: default -->
  1279. <element name="StartOfADay">
  1280. <short>Return the start of a day as a DateTime value, given a day indication</short>
  1281. </element>
  1282. <!-- function result Visibility: default -->
  1283. <element name="StartOfADay.Result">
  1284. <short>Start of the given day as DateTime</short>
  1285. </element>
  1286. <!-- argument Visibility: default -->
  1287. <element name="StartOfADay.AYear">
  1288. <short>Year</short>
  1289. </element>
  1290. <!-- argument Visibility: default -->
  1291. <element name="StartOfADay.AMonth">
  1292. <short>Month in the year</short>
  1293. </element>
  1294. <!-- argument Visibility: default -->
  1295. <element name="StartOfADay.ADay">
  1296. <short>Day in the month.</short>
  1297. </element>
  1298. <!-- argument Visibility: default -->
  1299. <element name="StartOfADay.ADayOfYear">
  1300. <short>Day in the year.</short>
  1301. </element>
  1302. <!-- function Visibility: default -->
  1303. <element name="EndOfADay">
  1304. <short>Calculates a DateTime value representing the end of a specified day</short>
  1305. </element>
  1306. <!-- function result Visibility: default -->
  1307. <element name="EndOfADay.Result">
  1308. <short>A datetime value representing the time 23:59:59.999 of the given day.</short>
  1309. </element>
  1310. <!-- argument Visibility: default -->
  1311. <element name="EndOfADay.AYear">
  1312. <short>Year</short>
  1313. </element>
  1314. <!-- argument Visibility: default -->
  1315. <element name="EndOfADay.AMonth">
  1316. <short>Month in the year</short>
  1317. </element>
  1318. <!-- argument Visibility: default -->
  1319. <element name="EndOfADay.ADay">
  1320. <short>Day in the month</short>
  1321. </element>
  1322. <!-- argument Visibility: default -->
  1323. <element name="EndOfADay.ADayOfYear">
  1324. <short>Day of the year</short>
  1325. </element>
  1326. <!-- function Visibility: default -->
  1327. <element name="MonthOfTheYear">
  1328. <short>Extract the month of a DateTime indication.</short>
  1329. </element>
  1330. <!-- function result Visibility: default -->
  1331. <element name="MonthOfTheYear.Result">
  1332. <short>The month part of <var>AValue</var></short>
  1333. </element>
  1334. <!-- argument Visibility: default -->
  1335. <element name="MonthOfTheYear.AValue">
  1336. <short>Date from which to extract month</short>
  1337. </element>
  1338. <!-- function Visibility: default -->
  1339. <element name="WeekOfTheYear">
  1340. <short>Extract the week of the year (and optionally year) of a DateTime indication.</short>
  1341. </element>
  1342. <!-- function result Visibility: default -->
  1343. <element name="WeekOfTheYear.Result">
  1344. <short>Week of the year in which <var>Avalue</var> falls.</short>
  1345. </element>
  1346. <!-- argument Visibility: default -->
  1347. <element name="WeekOfTheYear.AValue">
  1348. <short>Date from which to extract week.</short>
  1349. </element>
  1350. <!-- argument Visibility: default -->
  1351. <element name="WeekOfTheYear.AYear">
  1352. <short>Year part of <var>AValue</var></short>
  1353. </element>
  1354. <!-- function Visibility: default -->
  1355. <element name="DayOfTheYear">
  1356. <short>Extracts the day of the week from a DateTime value</short>
  1357. </element>
  1358. <!-- function result Visibility: default -->
  1359. <element name="DayOfTheYear.Result">
  1360. <short>Day of the year from <var>AValue</var>.</short>
  1361. </element>
  1362. <!-- argument Visibility: default -->
  1363. <element name="DayOfTheYear.AValue">
  1364. <short>DateTime to extract the day of the year from.</short>
  1365. </element>
  1366. <!-- function Visibility: default -->
  1367. <element name="HourOfTheYear">
  1368. <short>Calculate the number of hours passed since the start of the year.</short>
  1369. </element>
  1370. <!-- function result Visibility: default -->
  1371. <element name="HourOfTheYear.Result">
  1372. <short>Number of hours passed since the start of the year till <var>AValue</var> .</short>
  1373. </element>
  1374. <!-- argument Visibility: default -->
  1375. <element name="HourOfTheYear.AValue">
  1376. <short>DateTime value for which to calculate the hour of the year</short>
  1377. </element>
  1378. <!-- function Visibility: default -->
  1379. <element name="MinuteOfTheYear">
  1380. <short>Calculate the number of minutes elapsed since the start of the year</short>
  1381. </element>
  1382. <!-- function result Visibility: default -->
  1383. <element name="MinuteOfTheYear.Result">
  1384. <short>Number of minutes elapsed since the start of the year.</short>
  1385. </element>
  1386. <!-- argument Visibility: default -->
  1387. <element name="MinuteOfTheYear.AValue">
  1388. <short>Moment in the year.</short>
  1389. </element>
  1390. <!-- function Visibility: default -->
  1391. <element name="SecondOfTheYear">
  1392. <short>Calculate the number of seconds elapsed since the start of the year.</short>
  1393. </element>
  1394. <!-- function result Visibility: default -->
  1395. <element name="SecondOfTheYear.Result">
  1396. <short>Number of seconds elapsed since the start of the year.</short>
  1397. </element>
  1398. <!-- argument Visibility: default -->
  1399. <element name="SecondOfTheYear.AValue">
  1400. <short>Moment in the year</short>
  1401. </element>
  1402. <!-- function Visibility: default -->
  1403. <element name="MilliSecondOfTheYear">
  1404. <short>Calculate the number of milliseconds elapsed since the start of the year.</short>
  1405. </element>
  1406. <!-- function result Visibility: default -->
  1407. <element name="MilliSecondOfTheYear.Result">
  1408. <short>Number of seconds elapsed since the start of the year.</short>
  1409. </element>
  1410. <!-- argument Visibility: default -->
  1411. <element name="MilliSecondOfTheYear.AValue">
  1412. <short>Moment in the year</short>
  1413. </element>
  1414. <!-- function Visibility: default -->
  1415. <element name="WeekOfTheMonth">
  1416. <short>Extract the week of the month (and optionally month and year) from a DateTime value</short>
  1417. </element>
  1418. <!-- function result Visibility: default -->
  1419. <element name="WeekOfTheMonth.Result">
  1420. <short>Week of the month</short>
  1421. </element>
  1422. <!-- argument Visibility: default -->
  1423. <element name="WeekOfTheMonth.AValue">
  1424. <short>Datetime value of which to calculate the week, month and year.</short>
  1425. </element>
  1426. <!-- argument Visibility: default -->
  1427. <element name="WeekOfTheMonth.AYear">
  1428. <short>Year part of <var>AValue</var></short>
  1429. </element>
  1430. <!-- argument Visibility: default -->
  1431. <element name="WeekOfTheMonth.AMonth">
  1432. <short>Month part of <var>AValue</var></short>
  1433. </element>
  1434. <!-- function Visibility: default -->
  1435. <element name="DayOfTheMonth">
  1436. <short>Extract the day (of month) part of a DateTime value</short>
  1437. </element>
  1438. <!-- function result Visibility: default -->
  1439. <element name="DayOfTheMonth.Result">
  1440. <short>Day in the month</short>
  1441. </element>
  1442. <!-- argument Visibility: default -->
  1443. <element name="DayOfTheMonth.AValue">
  1444. <short>Datetime value to extract day from.</short>
  1445. </element>
  1446. <!-- function Visibility: default -->
  1447. <element name="HourOfTheMonth">
  1448. <short>Calculate the number of hours passed since the start of the month.</short>
  1449. </element>
  1450. <!-- function result Visibility: default -->
  1451. <element name="HourOfTheMonth.Result">
  1452. <short>Number of hours passed since the start of the month till <var>AValue</var>.</short>
  1453. </element>
  1454. <!-- argument Visibility: default -->
  1455. <element name="HourOfTheMonth.AValue">
  1456. <short>DateTime value for which to calculate the hour of the month.</short>
  1457. </element>
  1458. <!-- function Visibility: default -->
  1459. <element name="MinuteOfTheMonth">
  1460. <short>Calculate number of minutes elapsed since the start of the month.</short>
  1461. </element>
  1462. <!-- function result Visibility: default -->
  1463. <element name="MinuteOfTheMonth.Result">
  1464. <short>Number of minutes elapsed since the start of the month.</short>
  1465. </element>
  1466. <!-- argument Visibility: default -->
  1467. <element name="MinuteOfTheMonth.AValue">
  1468. <short>Moment in the month.</short>
  1469. </element>
  1470. <!-- function Visibility: default -->
  1471. <element name="SecondOfTheMonth">
  1472. <short>Calculate number of seconds elapsed since the start of the month.</short>
  1473. </element>
  1474. <!-- function result Visibility: default -->
  1475. <element name="SecondOfTheMonth.Result">
  1476. <short>Number of seconds elapsed since the start of the month.</short>
  1477. </element>
  1478. <!-- argument Visibility: default -->
  1479. <element name="SecondOfTheMonth.AValue">
  1480. <short>Moment in the month.</short>
  1481. </element>
  1482. <!-- function Visibility: default -->
  1483. <element name="MilliSecondOfTheMonth">
  1484. <short>Calculate number of milliseconds elapsed since the start of the month.</short>
  1485. </element>
  1486. <!-- function result Visibility: default -->
  1487. <element name="MilliSecondOfTheMonth.Result">
  1488. <short>Number of milliseconds elapsed since the start of the month.</short>
  1489. </element>
  1490. <!-- argument Visibility: default -->
  1491. <element name="MilliSecondOfTheMonth.AValue">
  1492. <short>Moment in the month</short>
  1493. </element>
  1494. <!-- function Visibility: default -->
  1495. <element name="DayOfTheWeek">
  1496. <short>Extracts the day of the week from a DateTime value</short>
  1497. </element>
  1498. <!-- function result Visibility: default -->
  1499. <element name="DayOfTheWeek.Result">
  1500. <short>Day of the week from <var>AValue</var>.</short>
  1501. </element>
  1502. <!-- argument Visibility: default -->
  1503. <element name="DayOfTheWeek.AValue">
  1504. <short>DateTime to extract the day of the week from.</short>
  1505. </element>
  1506. <!-- function Visibility: default -->
  1507. <element name="HourOfTheWeek">
  1508. <short>Calculate the number of hours elapsed since the start of the week.</short>
  1509. </element>
  1510. <!-- function result Visibility: default -->
  1511. <element name="HourOfTheWeek.Result">
  1512. <short>Number of hours elapsed since the start of the week till <var>AValue</var>.</short>
  1513. </element>
  1514. <!-- argument Visibility: default -->
  1515. <element name="HourOfTheWeek.AValue">
  1516. <short>DateTime value for which to calculate the hour of the week.</short>
  1517. </element>
  1518. <!-- function Visibility: default -->
  1519. <element name="MinuteOfTheWeek">
  1520. <short>Calculate the number of seconds elapsed since the start of the week</short>
  1521. </element>
  1522. <!-- function result Visibility: default -->
  1523. <element name="MinuteOfTheWeek.Result">
  1524. <short>Number of seconds elapsed since the start of the week</short>
  1525. </element>
  1526. <!-- argument Visibility: default -->
  1527. <element name="MinuteOfTheWeek.AValue">
  1528. <short>Moment in the week.</short>
  1529. </element>
  1530. <element name="SecondOfTheWeek">
  1531. <short>Calculate the number of seconds elapsed since the start of the week</short>
  1532. </element>
  1533. <!-- function result Visibility: default -->
  1534. <element name="SecondOfTheWeek.Result">
  1535. <short>Number of seconds elapsed since the start of the week</short>
  1536. </element>
  1537. <!-- argument Visibility: default -->
  1538. <element name="SecondOfTheWeek.AValue">
  1539. <short>Moment in the week</short>
  1540. </element>
  1541. <!-- function Visibility: default -->
  1542. <element name="MilliSecondOfTheWeek">
  1543. <short>Calculate the number of milliseconds elapsed since the start of the week</short>
  1544. </element>
  1545. <!-- function result Visibility: default -->
  1546. <element name="MilliSecondOfTheWeek.Result">
  1547. <short></short>
  1548. </element>
  1549. <!-- argument Visibility: default -->
  1550. <element name="MilliSecondOfTheWeek.AValue">
  1551. <short></short>
  1552. </element>
  1553. <!-- function Visibility: default -->
  1554. <element name="HourOfTheDay">
  1555. <short>Calculate the hour of a given DateTime value</short>
  1556. </element>
  1557. <!-- function result Visibility: default -->
  1558. <element name="HourOfTheDay.Result">
  1559. <short>Hour part of <var>AValue</var>.</short>
  1560. </element>
  1561. <!-- argument Visibility: default -->
  1562. <element name="HourOfTheDay.AValue">
  1563. <short>DateTime to calculate the hour of.</short>
  1564. </element>
  1565. <!-- function Visibility: default -->
  1566. <element name="MinuteOfTheDay">
  1567. <short>Calculate the number of minutes elapsed since the start of the day</short>
  1568. </element>
  1569. <!-- function result Visibility: default -->
  1570. <element name="MinuteOfTheDay.Result">
  1571. <short>Number of minutes elapsed since the start of the day</short>
  1572. </element>
  1573. <!-- argument Visibility: default -->
  1574. <element name="MinuteOfTheDay.AValue">
  1575. <short>Moment in the day</short>
  1576. </element>
  1577. <!-- function Visibility: default -->
  1578. <element name="SecondOfTheDay">
  1579. <short>Calculate the number of seconds elapsed since the start of the day</short>
  1580. </element>
  1581. <!-- function result Visibility: default -->
  1582. <element name="SecondOfTheDay.Result">
  1583. <short>Number of seconds elapsed since the start of the day</short>
  1584. </element>
  1585. <!-- argument Visibility: default -->
  1586. <element name="SecondOfTheDay.AValue">
  1587. <short>Moment in the day</short>
  1588. </element>
  1589. <!-- function Visibility: default -->
  1590. <element name="MilliSecondOfTheDay">
  1591. <short>Calculate the number of milliseconds elapsed since the start of the day</short>
  1592. </element>
  1593. <!-- function result Visibility: default -->
  1594. <element name="MilliSecondOfTheDay.Result">
  1595. <short>Number of milliseconds elapsed since the start of the day</short>
  1596. </element>
  1597. <!-- argument Visibility: default -->
  1598. <element name="MilliSecondOfTheDay.AValue">
  1599. <short>Moment in the day</short>
  1600. </element>
  1601. <!-- function Visibility: default -->
  1602. <element name="MinuteOfTheHour">
  1603. <short>Calculate the number of minutes elapsed since the start of the hour</short>
  1604. </element>
  1605. <!-- function result Visibility: default -->
  1606. <element name="MinuteOfTheHour.Result">
  1607. <short>Number of minutes elapsed since the start of the hour</short>
  1608. </element>
  1609. <!-- argument Visibility: default -->
  1610. <element name="MinuteOfTheHour.AValue">
  1611. <short>Moment in the hour</short>
  1612. </element>
  1613. <!-- function Visibility: default -->
  1614. <element name="SecondOfTheHour">
  1615. <short>Calculate the number of seconds elapsed since the start of the hour</short>
  1616. </element>
  1617. <!-- function result Visibility: default -->
  1618. <element name="SecondOfTheHour.Result">
  1619. <short>Number of seconds elapsed since the start of the hour</short>
  1620. </element>
  1621. <!-- argument Visibility: default -->
  1622. <element name="SecondOfTheHour.AValue">
  1623. <short>Moment in the hour</short>
  1624. </element>
  1625. <!-- function Visibility: default -->
  1626. <element name="MilliSecondOfTheHour">
  1627. <short>Calculate the number of milliseconds elapsed since the start of the hour</short>
  1628. </element>
  1629. <!-- function result Visibility: default -->
  1630. <element name="MilliSecondOfTheHour.Result">
  1631. <short>Number of milliseconds elapsed since the start of the hour</short>
  1632. </element>
  1633. <!-- argument Visibility: default -->
  1634. <element name="MilliSecondOfTheHour.AValue">
  1635. <short>Moment in the hour</short>
  1636. </element>
  1637. <!-- function Visibility: default -->
  1638. <element name="SecondOfTheMinute">
  1639. <short>Calculate the number of seconds elapsed since the start of the minute</short>
  1640. </element>
  1641. <!-- function result Visibility: default -->
  1642. <element name="SecondOfTheMinute.Result">
  1643. <short>Number of seconds elapsed since the start of the minute</short>
  1644. </element>
  1645. <!-- argument Visibility: default -->
  1646. <element name="SecondOfTheMinute.AValue">
  1647. <short>Moment in the minute</short>
  1648. </element>
  1649. <!-- function Visibility: default -->
  1650. <element name="MilliSecondOfTheMinute">
  1651. <short>Calculate the number of milliseconds elapsed since the start of the minute</short>
  1652. </element>
  1653. <!-- function result Visibility: default -->
  1654. <element name="MilliSecondOfTheMinute.Result">
  1655. <short>Number of milliseconds elapsed since the start of the minute</short>
  1656. </element>
  1657. <!-- argument Visibility: default -->
  1658. <element name="MilliSecondOfTheMinute.AValue">
  1659. <short>Moment in the minute</short>
  1660. </element>
  1661. <!-- function Visibility: default -->
  1662. <element name="MilliSecondOfTheSecond">
  1663. <short>Calculate the number of milliseconds elapsed since the start of the second</short>
  1664. </element>
  1665. <!-- function result Visibility: default -->
  1666. <element name="MilliSecondOfTheSecond.Result">
  1667. <short>Number of milliseconds elapsed since the start of the second</short>
  1668. </element>
  1669. <!-- argument Visibility: default -->
  1670. <element name="MilliSecondOfTheSecond.AValue">
  1671. <short>Moment in the second</short>
  1672. </element>
  1673. <!-- function Visibility: default -->
  1674. <element name="WithinPastYears">
  1675. <short>Check whether two datetimes are only a number of years apart</short>
  1676. </element>
  1677. <!-- function result Visibility: default -->
  1678. <element name="WithinPastYears.Result">
  1679. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AYears</var> apart,
  1680. <var>false</var> otherwise</short>
  1681. </element>
  1682. <!-- argument Visibility: default -->
  1683. <element name="WithinPastYears.ANow">
  1684. <short>First moment in time</short>
  1685. </element>
  1686. <!-- argument Visibility: default -->
  1687. <element name="WithinPastYears.AThen">
  1688. <short>Second moment in time</short>
  1689. </element>
  1690. <!-- argument Visibility: default -->
  1691. <element name="WithinPastYears.AYears">
  1692. <short>Number of years to check</short>
  1693. </element>
  1694. <!-- function Visibility: default -->
  1695. <element name="WithinPastMonths">
  1696. <short>Check whether two datetimes are only a number of months apart</short>
  1697. </element>
  1698. <!-- function result Visibility: default -->
  1699. <element name="WithinPastMonths.Result">
  1700. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AMonths</var> apart,
  1701. <var>false</var> otherwise</short>
  1702. </element>
  1703. <!-- argument Visibility: default -->
  1704. <element name="WithinPastMonths.ANow">
  1705. <short>First moment in time</short>
  1706. </element>
  1707. <!-- argument Visibility: default -->
  1708. <element name="WithinPastMonths.AThen">
  1709. <short>Second moment in time</short>
  1710. </element>
  1711. <!-- argument Visibility: default -->
  1712. <element name="WithinPastMonths.AMonths">
  1713. <short>Number of months to check</short>
  1714. </element>
  1715. <!-- function Visibility: default -->
  1716. <element name="WithinPastWeeks">
  1717. <short>Check whether two datetimes are only a number of weeks apart</short>
  1718. </element>
  1719. <!-- function result Visibility: default -->
  1720. <element name="WithinPastWeeks.Result">
  1721. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AWeeks</var> apart,
  1722. <var>false</var> otherwise</short>
  1723. </element>
  1724. <!-- argument Visibility: default -->
  1725. <element name="WithinPastWeeks.ANow">
  1726. <short>First moment in time</short>
  1727. </element>
  1728. <!-- argument Visibility: default -->
  1729. <element name="WithinPastWeeks.AThen">
  1730. <short>Second moment in time</short>
  1731. </element>
  1732. <!-- argument Visibility: default -->
  1733. <element name="WithinPastWeeks.AWeeks">
  1734. <short>Number of weeks to check</short>
  1735. </element>
  1736. <!-- function Visibility: default -->
  1737. <element name="WithinPastDays">
  1738. <short>Check whether two datetimes are only a number of days apart</short>
  1739. </element>
  1740. <!-- function result Visibility: default -->
  1741. <element name="WithinPastDays.Result">
  1742. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>ADays</var> apart,
  1743. <var>false</var> otherwise</short>
  1744. </element>
  1745. <!-- argument Visibility: default -->
  1746. <element name="WithinPastDays.ANow">
  1747. <short>First moment in time</short>
  1748. </element>
  1749. <!-- argument Visibility: default -->
  1750. <element name="WithinPastDays.AThen">
  1751. <short>Second moment in time</short>
  1752. </element>
  1753. <!-- argument Visibility: default -->
  1754. <element name="WithinPastDays.ADays">
  1755. <short>Number of days to check</short>
  1756. </element>
  1757. <!-- function Visibility: default -->
  1758. <element name="WithinPastHours">
  1759. <short>Check whether two datetimes are only a number of hours apart</short>
  1760. </element>
  1761. <!-- function result Visibility: default -->
  1762. <element name="WithinPastHours.Result">
  1763. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AHours</var> apart,
  1764. <var>false</var> otherwise</short>
  1765. </element>
  1766. <!-- argument Visibility: default -->
  1767. <element name="WithinPastHours.ANow">
  1768. <short>First moment in time</short>
  1769. </element>
  1770. <!-- argument Visibility: default -->
  1771. <element name="WithinPastHours.AThen">
  1772. <short>Second moment in time</short>
  1773. </element>
  1774. <!-- argument Visibility: default -->
  1775. <element name="WithinPastHours.AHours">
  1776. <short>Number of hours to check</short>
  1777. </element>
  1778. <!-- function Visibility: default -->
  1779. <element name="WithinPastMinutes">
  1780. <short>Check whether two datetimes are only a number of minutes apart</short>
  1781. </element>
  1782. <!-- function result Visibility: default -->
  1783. <element name="WithinPastMinutes.Result">
  1784. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AMinutes</var> apart,
  1785. <var>false</var> otherwise</short>
  1786. </element>
  1787. <!-- argument Visibility: default -->
  1788. <element name="WithinPastMinutes.ANow">
  1789. <short>First moment in time</short>
  1790. </element>
  1791. <!-- argument Visibility: default -->
  1792. <element name="WithinPastMinutes.AThen">
  1793. <short>Second moment in time</short>
  1794. </element>
  1795. <!-- argument Visibility: default -->
  1796. <element name="WithinPastMinutes.AMinutes">
  1797. <short>Number of minutes to check</short>
  1798. </element>
  1799. <!-- function Visibility: default -->
  1800. <element name="WithinPastSeconds">
  1801. <short>Check whether two datetimes are only a number of seconds apart</short>
  1802. </element>
  1803. <!-- function result Visibility: default -->
  1804. <element name="WithinPastSeconds.Result">
  1805. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>ASeconds</var> apart,
  1806. <var>false</var> otherwise</short>
  1807. </element>
  1808. <!-- argument Visibility: default -->
  1809. <element name="WithinPastSeconds.ANow">
  1810. <short>First moment in time</short>
  1811. </element>
  1812. <!-- argument Visibility: default -->
  1813. <element name="WithinPastSeconds.AThen">
  1814. <short>Second moment in time</short>
  1815. </element>
  1816. <!-- argument Visibility: default -->
  1817. <element name="WithinPastSeconds.ASeconds">
  1818. <short>Number of seconds to check</short>
  1819. </element>
  1820. <!-- function Visibility: default -->
  1821. <element name="WithinPastMilliSeconds">
  1822. <short>Check whether two datetimes are only a number of milliseconds apart</short>
  1823. </element>
  1824. <!-- function result Visibility: default -->
  1825. <element name="WithinPastMilliSeconds.Result">
  1826. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AMilliSeconds</var> apart,
  1827. <var>false</var> otherwise</short>
  1828. </element>
  1829. <!-- argument Visibility: default -->
  1830. <element name="WithinPastMilliSeconds.ANow">
  1831. <short>First moment in time</short>
  1832. </element>
  1833. <!-- argument Visibility: default -->
  1834. <element name="WithinPastMilliSeconds.AThen">
  1835. <short>Second moment in time</short>
  1836. </element>
  1837. <!-- argument Visibility: default -->
  1838. <element name="WithinPastMilliSeconds.AMilliSeconds">
  1839. <short>Number of milliseconds to check</short>
  1840. </element>
  1841. <!-- function Visibility: default -->
  1842. <element name="YearsBetween">
  1843. <short>Calculate the number of whole years between two DateTime values</short>
  1844. </element>
  1845. <!-- function result Visibility: default -->
  1846. <element name="YearsBetween.Result">
  1847. <short>Number of whole years between <var>ANow</var> and <var>AThen</var>.</short>
  1848. </element>
  1849. <!-- argument Visibility: default -->
  1850. <element name="YearsBetween.ANow">
  1851. <short>First moment in time</short>
  1852. </element>
  1853. <!-- argument Visibility: default -->
  1854. <element name="YearsBetween.AThen">
  1855. <short>Second moment in time</short>
  1856. </element>
  1857. <!-- function Visibility: default -->
  1858. <element name="MonthsBetween">
  1859. <short>Calculate the number of whole months between two DateTime values</short>
  1860. </element>
  1861. <!-- function result Visibility: default -->
  1862. <element name="MonthsBetween.Result">
  1863. <short>Number of whole months between <var>ANow</var> and <var>AThen</var>.</short>
  1864. </element>
  1865. <!-- argument Visibility: default -->
  1866. <element name="MonthsBetween.ANow">
  1867. <short>First moment in time</short>
  1868. </element>
  1869. <!-- argument Visibility: default -->
  1870. <element name="MonthsBetween.AThen">
  1871. <short>Second moment in time</short>
  1872. </element>
  1873. <!-- function Visibility: default -->
  1874. <element name="WeeksBetween">
  1875. <short>Calculate the number of whole weeks between two DateTime values</short>
  1876. </element>
  1877. <!-- function result Visibility: default -->
  1878. <element name="WeeksBetween.Result">
  1879. <short>Number of whole weeks between <var>ANow</var> and <var>AThen</var>.</short>
  1880. </element>
  1881. <!-- argument Visibility: default -->
  1882. <element name="WeeksBetween.ANow">
  1883. <short>First moment in time</short>
  1884. </element>
  1885. <!-- argument Visibility: default -->
  1886. <element name="WeeksBetween.AThen">
  1887. <short>Second moment in time</short>
  1888. </element>
  1889. <!-- function Visibility: default -->
  1890. <element name="DaysBetween">
  1891. <short>Number of whole days between two DateTime values.</short>
  1892. </element>
  1893. <!-- function result Visibility: default -->
  1894. <element name="DaysBetween.Result">
  1895. <short>Number of whole days between <var>ANow</var> and <var>AThen</var>.</short>
  1896. </element>
  1897. <!-- argument Visibility: default -->
  1898. <element name="DaysBetween.ANow">
  1899. <short>First date</short>
  1900. </element>
  1901. <!-- argument Visibility: default -->
  1902. <element name="DaysBetween.AThen">
  1903. <short>Second date</short>
  1904. </element>
  1905. <!-- function Visibility: default -->
  1906. <element name="HoursBetween">
  1907. <short>Calculate the number of whole hours between two DateTime values.</short>
  1908. </element>
  1909. <!-- function result Visibility: default -->
  1910. <element name="HoursBetween.Result">
  1911. <short>Number of hours between <var>ANow</var> and <var>AThen</var></short>
  1912. </element>
  1913. <!-- argument Visibility: default -->
  1914. <element name="HoursBetween.ANow">
  1915. <short>First DateTime value</short>
  1916. </element>
  1917. <!-- argument Visibility: default -->
  1918. <element name="HoursBetween.AThen">
  1919. <short>Second DateTime value</short>
  1920. </element>
  1921. <!-- function Visibility: default -->
  1922. <element name="MinutesBetween">
  1923. <short>Calculate the number of whole minutes between two DateTime values.</short>
  1924. </element>
  1925. <!-- function result Visibility: default -->
  1926. <element name="MinutesBetween.Result">
  1927. <short>Number of minutes between <var>ANow</var> and <var>AThen</var></short>
  1928. </element>
  1929. <!-- argument Visibility: default -->
  1930. <element name="MinutesBetween.ANow">
  1931. <short>First moment in time</short>
  1932. </element>
  1933. <!-- argument Visibility: default -->
  1934. <element name="MinutesBetween.AThen">
  1935. <short>Second moment in time</short>
  1936. </element>
  1937. <!-- function Visibility: default -->
  1938. <element name="SecondsBetween">
  1939. <short>Calculate the number of whole seconds between two DateTime values.</short>
  1940. </element>
  1941. <!-- function result Visibility: default -->
  1942. <element name="SecondsBetween.Result">
  1943. <short>Number of seconds between <var>ANow</var> and <var>AThen</var></short>
  1944. </element>
  1945. <!-- argument Visibility: default -->
  1946. <element name="SecondsBetween.ANow">
  1947. <short>First moment in time</short>
  1948. </element>
  1949. <!-- argument Visibility: default -->
  1950. <element name="SecondsBetween.AThen">
  1951. <short>Second moment in time</short>
  1952. </element>
  1953. <!-- function Visibility: default -->
  1954. <element name="MilliSecondsBetween">
  1955. <short>Calculate the number of whole milliseconds between two DateTime values.</short>
  1956. </element>
  1957. <!-- function result Visibility: default -->
  1958. <element name="MilliSecondsBetween.Result">
  1959. <short>Number of milliseconds between <var>ANow</var> and <var>AThen</var></short>
  1960. </element>
  1961. <!-- argument Visibility: default -->
  1962. <element name="MilliSecondsBetween.ANow">
  1963. <short>First moment in time</short>
  1964. </element>
  1965. <!-- argument Visibility: default -->
  1966. <element name="MilliSecondsBetween.AThen">
  1967. <short>Second moment in time</short>
  1968. </element>
  1969. <!-- function Visibility: default -->
  1970. <element name="YearSpan">
  1971. <short>Calculate the approximate number of years between two DateTime values.</short>
  1972. </element>
  1973. <!-- function result Visibility: default -->
  1974. <element name="YearSpan.Result">
  1975. <short>Number (fractions included) of years between <var>ANow</var> and <var>AThen</var></short>
  1976. </element>
  1977. <!-- argument Visibility: default -->
  1978. <element name="YearSpan.ANow">
  1979. <short>First moment in time</short>
  1980. </element>
  1981. <!-- argument Visibility: default -->
  1982. <element name="YearSpan.AThen">
  1983. <short>Second moment in time</short>
  1984. </element>
  1985. <!-- function Visibility: default -->
  1986. <element name="MonthSpan">
  1987. <short>Calculate the approximate number of months between two DateTime values.</short>
  1988. </element>
  1989. <!-- function result Visibility: default -->
  1990. <element name="MonthSpan.Result">
  1991. <short>Number (fractions included) of months between <var>ANow</var> and <var>AThen</var></short>
  1992. </element>
  1993. <!-- argument Visibility: default -->
  1994. <element name="MonthSpan.ANow">
  1995. <short>First moment in time</short>
  1996. </element>
  1997. <!-- argument Visibility: default -->
  1998. <element name="MonthSpan.AThen">
  1999. <short>Second moment in time</short>
  2000. </element>
  2001. <!-- function Visibility: default -->
  2002. <element name="WeekSpan">
  2003. <short>Calculate the approximate number of weeks between two DateTime values.</short>
  2004. </element>
  2005. <!-- function result Visibility: default -->
  2006. <element name="WeekSpan.Result">
  2007. <short>Number (fractions included) of weeks between <var>ANow</var> and <var>AThen</var></short>
  2008. </element>
  2009. <!-- argument Visibility: default -->
  2010. <element name="WeekSpan.ANow">
  2011. <short>First moment in time</short>
  2012. </element>
  2013. <!-- argument Visibility: default -->
  2014. <element name="WeekSpan.AThen">
  2015. <short>Second moment in time</short>
  2016. </element>
  2017. <!-- function Visibility: default -->
  2018. <element name="DaySpan">
  2019. <short>Calculate the approximate number of days between two DateTime values.</short>
  2020. </element>
  2021. <!-- function result Visibility: default -->
  2022. <element name="DaySpan.Result">
  2023. <short>Number (fractions included) of days between <var>ANow</var> and <var>AThen</var></short>
  2024. </element>
  2025. <!-- argument Visibility: default -->
  2026. <element name="DaySpan.ANow">
  2027. <short>First moment in time</short>
  2028. </element>
  2029. <!-- argument Visibility: default -->
  2030. <element name="DaySpan.AThen">
  2031. <short>Second moment in time</short>
  2032. </element>
  2033. <!-- function Visibility: default -->
  2034. <element name="HourSpan">
  2035. <short>Calculate the approximate number of hours between two DateTime values.</short>
  2036. </element>
  2037. <!-- function result Visibility: default -->
  2038. <element name="HourSpan.Result">
  2039. <short>Number (fractions included) of hours between <var>ANow</var> and <var>AThen</var></short>
  2040. </element>
  2041. <!-- argument Visibility: default -->
  2042. <element name="HourSpan.ANow">
  2043. <short>First moment in time</short>
  2044. </element>
  2045. <!-- argument Visibility: default -->
  2046. <element name="HourSpan.AThen">
  2047. <short>Second moment in time</short>
  2048. </element>
  2049. <!-- function Visibility: default -->
  2050. <element name="MinuteSpan">
  2051. <short>Calculate the approximate number of minutes between two DateTime values.</short>
  2052. </element>
  2053. <!-- function result Visibility: default -->
  2054. <element name="MinuteSpan.Result">
  2055. <short>Number (fractions included) of minutes between <var>ANow</var> and <var>AThen</var></short>
  2056. </element>
  2057. <!-- argument Visibility: default -->
  2058. <element name="MinuteSpan.ANow">
  2059. <short>First moment in time</short>
  2060. </element>
  2061. <!-- argument Visibility: default -->
  2062. <element name="MinuteSpan.AThen">
  2063. <short>Second moment in time</short>
  2064. </element>
  2065. <!-- function Visibility: default -->
  2066. <element name="SecondSpan">
  2067. <short>Calculate the approximate number of seconds between two DateTime values.</short>
  2068. </element>
  2069. <!-- function result Visibility: default -->
  2070. <element name="SecondSpan.Result">
  2071. <short>Number (fractions included) of seconds between <var>ANow</var> and <var>AThen</var></short>
  2072. </element>
  2073. <!-- argument Visibility: default -->
  2074. <element name="SecondSpan.ANow">
  2075. <short>First moment in time</short>
  2076. </element>
  2077. <!-- argument Visibility: default -->
  2078. <element name="SecondSpan.AThen">
  2079. <short>Second moment in time</short>
  2080. </element>
  2081. <!-- function Visibility: default -->
  2082. <element name="MilliSecondSpan">
  2083. <short>alculate the approximate number of seconds between two DateTime values.</short>
  2084. <descr>
  2085. <p>
  2086. Since millisecond are the smallest unit of a <var>TDateTime</var> value, the number
  2087. will always be an integer value, even though a double is returned.
  2088. </p>
  2089. </descr>
  2090. </element>
  2091. <!-- function result Visibility: default -->
  2092. <element name="MilliSecondSpan.Result">
  2093. <short>Number (fractions included) of seconds between <var>ANow</var> and <var>AThen</var></short>
  2094. </element>
  2095. <!-- argument Visibility: default -->
  2096. <element name="MilliSecondSpan.ANow">
  2097. <short>First moment in time</short>
  2098. </element>
  2099. <!-- argument Visibility: default -->
  2100. <element name="MilliSecondSpan.AThen">
  2101. <short>Second moment in time</short>
  2102. </element>
  2103. <!-- function Visibility: default -->
  2104. <element name="IncYear">
  2105. <short>Increase a DateTime value with a number of years.</short>
  2106. </element>
  2107. <!-- function result Visibility: default -->
  2108. <element name="IncYear.Result">
  2109. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfYears</var> years.</short>
  2110. </element>
  2111. <!-- argument Visibility: default -->
  2112. <element name="IncYear.AValue">
  2113. <short>DateTime to which years should be added.</short>
  2114. </element>
  2115. <!-- argument Visibility: default -->
  2116. <element name="IncWeek.ANumberOfWeeks">
  2117. <short>Number of weeks to add</short>
  2118. </element>
  2119. <!-- function Visibility: default -->
  2120. <element name="IncWeek">
  2121. <short>Increase a DateTime value with a number of weeks.</short>
  2122. </element>
  2123. <!-- function result Visibility: default -->
  2124. <element name="IncWeek.Result">
  2125. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfWeeks</var> weeks.</short>
  2126. </element>
  2127. <!-- argument Visibility: default -->
  2128. <element name="IncWeek.AValue">
  2129. <short>DateTime to which weeks should be added.</short>
  2130. </element>
  2131. <!-- argument Visibility: default -->
  2132. <element name="IncDay.ANumberOfDays">
  2133. <short>Number of days to add.</short>
  2134. </element>
  2135. <!-- function Visibility: default -->
  2136. <element name="IncDay">
  2137. <short>Increase a DateTime value with a number of days.</short>
  2138. </element>
  2139. <!-- function result Visibility: default -->
  2140. <element name="IncDay.Result">
  2141. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfDays</var> days.</short>
  2142. </element>
  2143. <!-- argument Visibility: default -->
  2144. <element name="IncDay.AValue">
  2145. <short>DateTime value to which days should be added.</short>
  2146. </element>
  2147. <!-- argument Visibility: default -->
  2148. <element name="IncHour.ANumberOfHours">
  2149. <short>Number of hours to add</short>
  2150. </element>
  2151. <!-- function Visibility: default -->
  2152. <element name="IncHour">
  2153. <short>Increase a DateTime value with a number of hours.</short>
  2154. </element>
  2155. <!-- function result Visibility: default -->
  2156. <element name="IncHour.Result">
  2157. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfHours</var> hours.</short>
  2158. </element>
  2159. <!-- argument Visibility: default -->
  2160. <element name="IncHour.AValue">
  2161. <short>DateTime to which hours should be added.</short>
  2162. </element>
  2163. <!-- argument Visibility: default -->
  2164. <element name="IncMinute.ANumberOfMinutes">
  2165. <short>Number of minutes to add</short>
  2166. </element>
  2167. <!-- function Visibility: default -->
  2168. <element name="IncMinute">
  2169. <short>Increase a DateTime value with a number of minutes.</short>
  2170. </element>
  2171. <!-- function result Visibility: default -->
  2172. <element name="IncMinute.Result">
  2173. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfMinutes</var> minutes.</short>
  2174. </element>
  2175. <!-- argument Visibility: default -->
  2176. <element name="IncMinute.AValue">
  2177. <short>DateTime to which minutes should be added.</short>
  2178. </element>
  2179. <!-- argument Visibility: default -->
  2180. <element name="IncSecond.ANumberOfSeconds">
  2181. <short>Number of seconds to add</short>
  2182. </element>
  2183. <!-- function Visibility: default -->
  2184. <element name="IncSecond">
  2185. <short>Increase a DateTime value with a number of seconds.</short>
  2186. </element>
  2187. <!-- function result Visibility: default -->
  2188. <element name="IncSecond.Result">
  2189. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfSeconds</var> seconds.</short>
  2190. </element>
  2191. <!-- argument Visibility: default -->
  2192. <element name="IncSecond.AValue">
  2193. <short>DateTime to which seconds should be added.</short>
  2194. </element>
  2195. <!-- argument Visibility: default -->
  2196. <element name="IncMilliSecond.ANumberOfMilliSeconds">
  2197. <short>Number of milliseconds to add</short>
  2198. </element>
  2199. <!-- function Visibility: default -->
  2200. <element name="IncMilliSecond">
  2201. <short>Increase a DateTime value with a number of milliseconds.</short>
  2202. </element>
  2203. <!-- function result Visibility: default -->
  2204. <element name="IncMilliSecond.Result">
  2205. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfMilliSeconds</var> milliseconds.</short>
  2206. </element>
  2207. <!-- argument Visibility: default -->
  2208. <element name="IncMilliSecond.AValue">
  2209. <short>DateTime to which milliseconds should be added.</short>
  2210. </element>
  2211. <!-- function Visibility: default -->
  2212. <element name="EncodeDateTime">
  2213. <short>Encodes a DateTime value from all its parts</short>
  2214. </element>
  2215. <!-- function result Visibility: default -->
  2216. <element name="EncodeDateTime.Result">
  2217. <short>DateTime value representing the complete timestamp</short>
  2218. </element>
  2219. <!-- argument Visibility: default -->
  2220. <element name="EncodeDateTime.AYear">
  2221. <short>Year</short>
  2222. </element>
  2223. <!-- argument Visibility: default -->
  2224. <element name="EncodeDateTime.AMonth">
  2225. <short>Month</short>
  2226. </element>
  2227. <!-- argument Visibility: default -->
  2228. <element name="EncodeDateTime.ADay">
  2229. <short>Day of the month</short>
  2230. </element>
  2231. <!-- argument Visibility: default -->
  2232. <element name="EncodeDateTime.AHour">
  2233. <short>Hour of the day</short>
  2234. </element>
  2235. <!-- argument Visibility: default -->
  2236. <element name="EncodeDateTime.AMinute">
  2237. <short>Minutes</short>
  2238. </element>
  2239. <!-- argument Visibility: default -->
  2240. <element name="EncodeDateTime.ASecond">
  2241. <short>Seconds</short>
  2242. </element>
  2243. <!-- argument Visibility: default -->
  2244. <element name="EncodeDateTime.AMilliSecond">
  2245. <short>Milliseconds</short>
  2246. </element>
  2247. <!-- procedure Visibility: default -->
  2248. <element name="DecodeDateTime">
  2249. <short>Decode a datetime value in a date and time value</short>
  2250. </element>
  2251. <!-- argument Visibility: default -->
  2252. <element name="DecodeDateTime.AValue">
  2253. <short>DateTime to decode</short>
  2254. </element>
  2255. <!-- argument Visibility: default -->
  2256. <element name="DecodeDateTime.AYear">
  2257. <short>Returns the year part of <var>AValue</var>.</short>
  2258. </element>
  2259. <!-- argument Visibility: default -->
  2260. <element name="DecodeDateTime.AMonth">
  2261. <short>Returns the month part of <var>AValue</var>.</short>
  2262. </element>
  2263. <!-- argument Visibility: default -->
  2264. <element name="DecodeDateTime.ADay">
  2265. <short>Returns the day part of <var>AValue</var>.</short>
  2266. </element>
  2267. <!-- argument Visibility: default -->
  2268. <element name="DecodeDateTime.AHour">
  2269. <short>Returns the hour part of <var>AValue</var>.</short>
  2270. </element>
  2271. <!-- argument Visibility: default -->
  2272. <element name="DecodeDateTime.AMinute">
  2273. <short>Returns the minute part of <var>AValue</var>.</short>
  2274. </element>
  2275. <!-- argument Visibility: default -->
  2276. <element name="DecodeDateTime.ASecond">
  2277. <short>Returns the second part of <var>AValue</var>.</short>
  2278. </element>
  2279. <!-- argument Visibility: default -->
  2280. <element name="DecodeDateTime.AMilliSecond">
  2281. <short>Returns the millisecond part of <var>AValue</var>.</short>
  2282. </element>
  2283. <!-- function Visibility: default -->
  2284. <element name="TryEncodeDateTime">
  2285. <short>Encode a Year, Month, Day, Hour, minute, seconds, milliseconds tuplet to a <var>TDateTime</var> value</short>
  2286. </element>
  2287. <!-- function result Visibility: default -->
  2288. <element name="TryEncodeDateTime.Result">
  2289. <short><var>True</var> if the encoding was succesful</short>
  2290. </element>
  2291. <!-- argument Visibility: default -->
  2292. <element name="TryEncodeDateTime.AYear">
  2293. <short>Year</short>
  2294. </element>
  2295. <!-- argument Visibility: default -->
  2296. <element name="TryEncodeDateTime.AMonth">
  2297. <short>Month in year</short>
  2298. </element>
  2299. <!-- argument Visibility: default -->
  2300. <element name="TryEncodeDateTime.ADay">
  2301. <short>Day in month</short>
  2302. </element>
  2303. <!-- argument Visibility: default -->
  2304. <element name="TryEncodeDateTime.AHour">
  2305. <short>Hour of the day</short>
  2306. </element>
  2307. <!-- argument Visibility: default -->
  2308. <element name="TryEncodeDateTime.AMinute">
  2309. <short>Minutes in the hour</short>
  2310. </element>
  2311. <!-- argument Visibility: default -->
  2312. <element name="TryEncodeDateTime.ASecond">
  2313. <short>Seconds in the minute</short>
  2314. </element>
  2315. <!-- argument Visibility: default -->
  2316. <element name="TryEncodeDateTime.AMilliSecond">
  2317. <short>Millisecond in the second</short>
  2318. </element>
  2319. <!-- argument Visibility: default -->
  2320. <element name="TryEncodeDateTime.AValue">
  2321. <short>Encoded <var>TDateTime</var> value.</short>
  2322. </element>
  2323. <!-- function Visibility: default -->
  2324. <element name="EncodeDateWeek">
  2325. <short>Encode a <var>TDateTime</var> value from a year, week and day of week triplet</short>
  2326. </element>
  2327. <!-- function result Visibility: default -->
  2328. <element name="EncodeDateWeek.Result">
  2329. <short>DateTime value representing <var>AYear</var>, <var>AWeekOfYear</var> and <var>ADayOfWeek</var>.</short>
  2330. </element>
  2331. <!-- argument Visibility: default -->
  2332. <element name="EncodeDateWeek.AYear">
  2333. <short>Year part</short>
  2334. </element>
  2335. <!-- argument Visibility: default -->
  2336. <element name="EncodeDateWeek.AWeekOfYear">
  2337. <short>Week of the year part</short>
  2338. </element>
  2339. <!-- procedure Visibility: default -->
  2340. <element name="DecodeDateWeek">
  2341. <short>Decode a DateTime value in a week of year and day of week.</short>
  2342. </element>
  2343. <!-- argument Visibility: default -->
  2344. <element name="DecodeDateWeek.AValue">
  2345. <short>DateTime to decode</short>
  2346. </element>
  2347. <!-- argument Visibility: default -->
  2348. <element name="DecodeDateWeek.AYear">
  2349. <short>Returns the year part of <var>AValue</var>.</short>
  2350. </element>
  2351. <!-- argument Visibility: default -->
  2352. <element name="DecodeDateWeek.AWeekOfYear">
  2353. <short>Returns the week of year part of <var>AValue</var>.</short>
  2354. </element>
  2355. <!-- argument Visibility: default -->
  2356. <element name="DecodeDateWeek.ADayOfWeek">
  2357. <short>Returns the day of week part of <var>AValue</var>.</short>
  2358. </element>
  2359. <!-- function Visibility: default -->
  2360. <element name="TryEncodeDateWeek">
  2361. <short>Encode a year, week and day of week triplet to a <var>TDateTime</var> value</short>
  2362. </element>
  2363. <!-- function result Visibility: default -->
  2364. <element name="TryEncodeDateWeek.Result">
  2365. <short><var>True</var> if the encoding was succeful, <var>False</var> otherwise.</short>
  2366. </element>
  2367. <!-- argument Visibility: default -->
  2368. <element name="TryEncodeDateWeek.AYear">
  2369. <short>Year</short>
  2370. </element>
  2371. <!-- argument Visibility: default -->
  2372. <element name="TryEncodeDateWeek.AWeekOfYear">
  2373. <short>Week in the year</short>
  2374. </element>
  2375. <!-- argument Visibility: default -->
  2376. <element name="TryEncodeDateWeek.AValue">
  2377. <short>Encoded <var>TDateTime</var> value</short>
  2378. </element>
  2379. <!-- argument Visibility: default -->
  2380. <element name="TryEncodeDateWeek.ADayOfWeek">
  2381. <short>Day of the week (default 1).</short>
  2382. </element>
  2383. <!-- function Visibility: default -->
  2384. <element name="EncodeDateDay">
  2385. <short>Encodes a year and day of year to a DateTime value</short>
  2386. </element>
  2387. <!-- function result Visibility: default -->
  2388. <element name="EncodeDateDay.Result">
  2389. <short>DateTime value representing the date specified by <var>AYear</var> and <var>ADayOfYear</var>.</short>
  2390. </element>
  2391. <!-- argument Visibility: default -->
  2392. <element name="EncodeDateDay.AYear">
  2393. <short>Year part.</short>
  2394. </element>
  2395. <!-- argument Visibility: default -->
  2396. <element name="EncodeDateDay.ADayOfYear">
  2397. <short>Day of the year part</short>
  2398. </element>
  2399. <!-- procedure Visibility: default -->
  2400. <element name="DecodeDateDay">
  2401. <short>Decode a DateTime value in year and year of day.</short>
  2402. </element>
  2403. <!-- argument Visibility: default -->
  2404. <element name="DecodeDateDay.AValue">
  2405. <short>DateTime to decode</short>
  2406. </element>
  2407. <!-- argument Visibility: default -->
  2408. <element name="DecodeDateDay.AYear">
  2409. <short>Returns the year part of <var>AValue</var></short>
  2410. </element>
  2411. <!-- argument Visibility: default -->
  2412. <element name="DecodeDateDay.ADayOfYear">
  2413. <short>Returns the day-of-year part of <var>AValue</var></short>
  2414. </element>
  2415. <!-- function Visibility: default -->
  2416. <element name="TryEncodeDateDay">
  2417. <short>Encode a year and day of year to a <var>TDateTime</var> value</short>
  2418. </element>
  2419. <!-- function result Visibility: default -->
  2420. <element name="TryEncodeDateDay.Result">
  2421. <short><var>True</var> if the encoding was succesful, <var>False</var> if not.</short>
  2422. </element>
  2423. <!-- argument Visibility: default -->
  2424. <element name="TryEncodeDateDay.AYear">
  2425. <short>Year</short>
  2426. </element>
  2427. <!-- argument Visibility: default -->
  2428. <element name="TryEncodeDateDay.ADayOfYear">
  2429. <short>Day in the year</short>
  2430. </element>
  2431. <!-- argument Visibility: default -->
  2432. <element name="TryEncodeDateDay.AValue">
  2433. <short>Encoded <var>TDateTime</var> value.</short>
  2434. </element>
  2435. <!-- function Visibility: default -->
  2436. <element name="EncodeDateMonthWeek">
  2437. <short>Encodes a year, month, week of month and day of week to a DateTime value</short>
  2438. </element>
  2439. <!-- function result Visibility: default -->
  2440. <element name="EncodeDateMonthWeek.Result">
  2441. <short>DateTime value representing the date specified by <var>AYear</var>, <var>AMonth</var>, <var>AWeekOfMonth</var> and <var>ADayOfWeek</var>.</short>
  2442. </element>
  2443. <!-- argument Visibility: default -->
  2444. <element name="EncodeDateMonthWeek.AYear">
  2445. <short>Year part</short>
  2446. </element>
  2447. <!-- argument Visibility: default -->
  2448. <element name="EncodeDateMonthWeek.AMonth">
  2449. <short>Month part</short>
  2450. </element>
  2451. <!-- argument Visibility: default -->
  2452. <element name="EncodeDateMonthWeek.AWeekOfMonth">
  2453. <short>Week of the month part</short>
  2454. </element>
  2455. <!-- argument Visibility: default -->
  2456. <element name="EncodeDateMonthWeek.ADayOfWeek">
  2457. <short>Day of the week part</short>
  2458. </element>
  2459. <!-- procedure Visibility: default -->
  2460. <element name="DecodeDateMonthWeek">
  2461. <short>Decode a DateTime value in a month, week of month and day of week</short>
  2462. </element>
  2463. <!-- argument Visibility: default -->
  2464. <element name="DecodeDateMonthWeek.AValue">
  2465. <short>DateTime to decode</short>
  2466. </element>
  2467. <!-- argument Visibility: default -->
  2468. <element name="DecodeDateMonthWeek.AYear">
  2469. <short>Returns the year part of <var>AValue</var>.</short>
  2470. </element>
  2471. <!-- argument Visibility: default -->
  2472. <element name="DecodeDateMonthWeek.AMonth">
  2473. <short>Returns the month part of <var>AValue</var>.</short>
  2474. </element>
  2475. <!-- argument Visibility: default -->
  2476. <element name="DecodeDateMonthWeek.AWeekOfMonth">
  2477. <short>Returns the week of month part of <var>AValue</var>.</short>
  2478. </element>
  2479. <!-- argument Visibility: default -->
  2480. <element name="DecodeDateMonthWeek.ADayOfWeek">
  2481. <short>Returns the day of week part of <var>AValue</var>.</short>
  2482. </element>
  2483. <!-- function Visibility: default -->
  2484. <element name="TryEncodeDateMonthWeek">
  2485. <short>Encode a year, month, week of month and day of week to a <var>TDateTime</var> value</short>
  2486. </element>
  2487. <!-- function result Visibility: default -->
  2488. <element name="TryEncodeDateMonthWeek.Result">
  2489. <short><var>True</var> if the encoding was succesful, <var>False</var> if not.</short>
  2490. </element>
  2491. <!-- argument Visibility: default -->
  2492. <element name="TryEncodeDateMonthWeek.AYear">
  2493. <short>Year</short>
  2494. </element>
  2495. <!-- argument Visibility: default -->
  2496. <element name="TryEncodeDateMonthWeek.AMonth">
  2497. <short>Month in the year</short>
  2498. </element>
  2499. <!-- argument Visibility: default -->
  2500. <element name="TryEncodeDateMonthWeek.AWeekOfMonth">
  2501. <short>Week in the month</short>
  2502. </element>
  2503. <!-- argument Visibility: default -->
  2504. <element name="TryEncodeDateMonthWeek.ADayOfWeek">
  2505. <short>Day in the week</short>
  2506. </element>
  2507. <!-- argument Visibility: default -->
  2508. <element name="TryEncodeDateMonthWeek.AValue">
  2509. <short>Encoded <var>TDateTime</var> value</short>
  2510. </element>
  2511. <!-- function Visibility: default -->
  2512. <element name="RecodeYear">
  2513. <short>Replace year part of a <var>TDateTime</var> value with another year.</short>
  2514. </element>
  2515. <!-- function result Visibility: default -->
  2516. <element name="RecodeYear.Result">
  2517. <short><var>AValue</var> with replaced year.</short>
  2518. </element>
  2519. <!-- argument Visibility: default -->
  2520. <element name="RecodeYear.AValue">
  2521. <short>Date to recode</short>
  2522. </element>
  2523. <!-- argument Visibility: default -->
  2524. <element name="RecodeYear.AYear">
  2525. <short>Year to replace in <var>AValue</var></short>
  2526. </element>
  2527. <!-- function Visibility: default -->
  2528. <element name="RecodeMonth">
  2529. <short>Replace month part of a <var>TDateTime</var> value with another month.</short>
  2530. </element>
  2531. <!-- function result Visibility: default -->
  2532. <element name="RecodeMonth.Result">
  2533. <short><var>AValue</var> with replaced month.</short>
  2534. </element>
  2535. <!-- argument Visibility: default -->
  2536. <element name="RecodeMonth.AValue">
  2537. <short>Date to recode</short>
  2538. </element>
  2539. <!-- argument Visibility: default -->
  2540. <element name="RecodeMonth.AMonth">
  2541. <short>Month to replace in <var>AValue</var></short>
  2542. </element>
  2543. <!-- function Visibility: default -->
  2544. <element name="RecodeDay">
  2545. <short>Replace day part of a <var>TDateTime</var> value with another day.</short>
  2546. </element>
  2547. <!-- function result Visibility: default -->
  2548. <element name="RecodeDay.Result">
  2549. <short><var>AValue</var> with replaced day.</short>
  2550. </element>
  2551. <!-- argument Visibility: default -->
  2552. <element name="RecodeDay.AValue">
  2553. <short>Date to recode</short>
  2554. </element>
  2555. <!-- argument Visibility: default -->
  2556. <element name="RecodeDay.ADay">
  2557. <short>Day to replace in <var>AValue</var></short>
  2558. </element>
  2559. <!-- function Visibility: default -->
  2560. <element name="RecodeHour">
  2561. <short>Replace hours part of a <var>TDateTime</var> value with another hour.</short>
  2562. </element>
  2563. <!-- function result Visibility: default -->
  2564. <element name="RecodeHour.Result">
  2565. <short><var>AValue</var> with replaced hour.</short>
  2566. </element>
  2567. <!-- argument Visibility: default -->
  2568. <element name="RecodeHour.AValue">
  2569. <short>Date/time to recode</short>
  2570. </element>
  2571. <!-- argument Visibility: default -->
  2572. <element name="RecodeHour.AHour">
  2573. <short>Hour to replace in <var>AValue</var></short>
  2574. </element>
  2575. <!-- function Visibility: default -->
  2576. <element name="RecodeMinute">
  2577. <short>Replace minutse part of a <var>TDateTime</var> value with another minute.</short>
  2578. </element>
  2579. <!-- function result Visibility: default -->
  2580. <element name="RecodeMinute.Result">
  2581. <short><var>AValue</var> with replaced minute.</short>
  2582. </element>
  2583. <!-- argument Visibility: default -->
  2584. <element name="RecodeMinute.AValue">
  2585. <short>Date/time to recode</short>
  2586. </element>
  2587. <!-- argument Visibility: default -->
  2588. <element name="RecodeMinute.AMinute">
  2589. <short>Minute to replace in <var>AValue</var></short>
  2590. </element>
  2591. <!-- function Visibility: default -->
  2592. <element name="RecodeSecond">
  2593. <short>Replace seconds part of a <var>TDateTime</var> value with another second.</short>
  2594. </element>
  2595. <!-- function result Visibility: default -->
  2596. <element name="RecodeSecond.Result">
  2597. <short><var>AValue</var> with replaced second.</short>
  2598. </element>
  2599. <!-- argument Visibility: default -->
  2600. <element name="RecodeSecond.AValue">
  2601. <short>Date/time to recode</short>
  2602. </element>
  2603. <!-- argument Visibility: default -->
  2604. <element name="RecodeSecond.ASecond">
  2605. <short>Second to replace in <var>AValue</var></short>
  2606. </element>
  2607. <!-- function Visibility: default -->
  2608. <element name="RecodeMilliSecond">
  2609. <short>Replace milliseconds part of a <var>TDateTime</var> value with another millisecond.</short>
  2610. </element>
  2611. <!-- function result Visibility: default -->
  2612. <element name="RecodeMilliSecond.Result">
  2613. <short><var>AValue</var> with replaced millisecond.</short>
  2614. </element>
  2615. <!-- argument Visibility: default -->
  2616. <element name="RecodeMilliSecond.AValue">
  2617. <short>Date/time to recode</short>
  2618. </element>
  2619. <!-- argument Visibility: default -->
  2620. <element name="RecodeMilliSecond.AMilliSecond">
  2621. <short>Millisecond to replace in <var>AValue</var></short>
  2622. </element>
  2623. <!-- function Visibility: default -->
  2624. <element name="RecodeDate">
  2625. <short>Replace date part of a <var>TDateTime</var> value with another date.</short>
  2626. </element>
  2627. <!-- function result Visibility: default -->
  2628. <element name="RecodeDate.Result">
  2629. <short><var>AValue</var> with replaced date.</short>
  2630. </element>
  2631. <!-- argument Visibility: default -->
  2632. <element name="RecodeDate.AValue">
  2633. <short>Date/time to recode</short>
  2634. </element>
  2635. <!-- argument Visibility: default -->
  2636. <element name="RecodeDate.AYear">
  2637. <short>Year to replace in <var>AValue</var></short>
  2638. </element>
  2639. <!-- argument Visibility: default -->
  2640. <element name="RecodeDate.AMonth">
  2641. <short>Month to replace in <var>AValue</var></short>
  2642. </element>
  2643. <!-- argument Visibility: default -->
  2644. <element name="RecodeDate.ADay">
  2645. <short>Day to replace in <var>AValue</var></short>
  2646. </element>
  2647. <!-- function Visibility: default -->
  2648. <element name="RecodeTime">
  2649. <short>Replace time part of a <var>TDateTime</var> value with another time.</short>
  2650. </element>
  2651. <!-- function result Visibility: default -->
  2652. <element name="RecodeTime.Result">
  2653. <short><var>AValue</var> with replaced time.</short>
  2654. </element>
  2655. <!-- argument Visibility: default -->
  2656. <element name="RecodeTime.AValue">
  2657. <short>Date/time to recode</short>
  2658. </element>
  2659. <!-- argument Visibility: default -->
  2660. <element name="RecodeTime.AHour">
  2661. <short>Hour to replace in <var>AValue</var></short>
  2662. </element>
  2663. <!-- argument Visibility: default -->
  2664. <element name="RecodeTime.AMinute">
  2665. <short>Minute to replace in <var>AValue</var></short>
  2666. </element>
  2667. <!-- argument Visibility: default -->
  2668. <element name="RecodeTime.ASecond">
  2669. <short>Second to replace in <var>AValue</var></short>
  2670. </element>
  2671. <!-- argument Visibility: default -->
  2672. <element name="RecodeTime.AMilliSecond">
  2673. <short>Millisecond to replace in <var>AValue</var></short>
  2674. </element>
  2675. <!-- function Visibility: default -->
  2676. <element name="RecodeDateTime">
  2677. <short>Replace selected parts of a <var>TDateTime</var> value with other values </short>
  2678. </element>
  2679. <!-- function result Visibility: default -->
  2680. <element name="RecodeDateTime.Result">
  2681. <short><var>AValue</var> with replaced parts</short>
  2682. </element>
  2683. <!-- argument Visibility: default -->
  2684. <element name="RecodeDateTime.AValue">
  2685. <short>Date/time to recode</short>
  2686. </element>
  2687. <!-- argument Visibility: default -->
  2688. <element name="RecodeDateTime.AYear">
  2689. <short>New value for year part</short>
  2690. </element>
  2691. <!-- argument Visibility: default -->
  2692. <element name="RecodeDateTime.AMonth">
  2693. <short>New value for month part</short>
  2694. </element>
  2695. <!-- argument Visibility: default -->
  2696. <element name="RecodeDateTime.ADay">
  2697. <short>New value for day part</short>
  2698. </element>
  2699. <!-- argument Visibility: default -->
  2700. <element name="RecodeDateTime.AHour">
  2701. <short>New value for hour part</short>
  2702. </element>
  2703. <!-- argument Visibility: default -->
  2704. <element name="RecodeDateTime.AMinute">
  2705. <short>New value for minute part</short>
  2706. </element>
  2707. <!-- argument Visibility: default -->
  2708. <element name="RecodeDateTime.ASecond">
  2709. <short>New value for second part</short>
  2710. </element>
  2711. <!-- argument Visibility: default -->
  2712. <element name="RecodeDateTime.AMilliSecond">
  2713. <short>New value for millisecond part</short>
  2714. </element>
  2715. <!-- function Visibility: default -->
  2716. <element name="TryRecodeDateTime">
  2717. <short>Replace selected parts of a <var>TDateTime</var> value with other values</short>
  2718. </element>
  2719. <!-- function result Visibility: default -->
  2720. <element name="TryRecodeDateTime.Result">
  2721. <short><var>True</var> if the recoding was succesful, <var>False</var> if not.</short>
  2722. </element>
  2723. <!-- argument Visibility: default -->
  2724. <element name="TryRecodeDateTime.AValue">
  2725. <short>Date/time to recode</short>
  2726. </element>
  2727. <!-- argument Visibility: default -->
  2728. <element name="TryRecodeDateTime.AYear">
  2729. <short>New value for year part</short>
  2730. </element>
  2731. <!-- argument Visibility: default -->
  2732. <element name="TryRecodeDateTime.AMonth">
  2733. <short>New value for month part</short>
  2734. </element>
  2735. <!-- argument Visibility: default -->
  2736. <element name="TryRecodeDateTime.ADay">
  2737. <short>New value for day part</short>
  2738. </element>
  2739. <!-- argument Visibility: default -->
  2740. <element name="TryRecodeDateTime.AHour">
  2741. <short>New value for hour part</short>
  2742. </element>
  2743. <!-- argument Visibility: default -->
  2744. <element name="TryRecodeDateTime.AMinute">
  2745. <short>New value for minute part</short>
  2746. </element>
  2747. <!-- argument Visibility: default -->
  2748. <element name="TryRecodeDateTime.ASecond">
  2749. <short>New value for second part</short>
  2750. </element>
  2751. <!-- argument Visibility: default -->
  2752. <element name="TryRecodeDateTime.AMilliSecond">
  2753. <short>New value for millisecond part</short>
  2754. </element>
  2755. <!-- argument Visibility: default -->
  2756. <element name="TryRecodeDateTime.AResult">
  2757. <short>Recoded <var>AValue</var>.</short>
  2758. </element>
  2759. <!-- function Visibility: default -->
  2760. <element name="CompareDateTime">
  2761. <short>Compare 2 dates, taking into account the time of day</short>
  2762. </element>
  2763. <!-- function result Visibility: default -->
  2764. <element name="CompareDateTime.Result">
  2765. <short>A negative number if <var>A</var> is earlier than <var>B</var>, zero if they are equal, or positive if <var>A</var> is later than <var>B</var>.</short>
  2766. </element>
  2767. <!-- argument Visibility: default -->
  2768. <element name="CompareDateTime.A">
  2769. <short>First date-time to compare</short>
  2770. </element>
  2771. <!-- argument Visibility: default -->
  2772. <element name="CompareDateTime.B">
  2773. <short>First date-time to compare</short>
  2774. </element>
  2775. <!-- function Visibility: default -->
  2776. <element name="CompareDate">
  2777. <short>Compare 2 dates, disregarding the time of day</short>
  2778. </element>
  2779. <!-- function result Visibility: default -->
  2780. <element name="CompareDate.Result">
  2781. <short>A negative number if date <var>A</var> is before <var>B</var>, zero if they are equal, or positive if <var>A</var> is after <var>B</var>.</short>
  2782. </element>
  2783. <!-- argument Visibility: default -->
  2784. <element name="CompareDate.A">
  2785. <short>First date to compare</short>
  2786. </element>
  2787. <!-- argument Visibility: default -->
  2788. <element name="CompareDate.B">
  2789. <short>Second date to compare</short>
  2790. </element>
  2791. <!-- function Visibility: default -->
  2792. <element name="CompareTime">
  2793. <short>Compares two times of the day, disregarding the date part.</short>
  2794. </element>
  2795. <!-- function result Visibility: default -->
  2796. <element name="CompareTime.Result">
  2797. <short>A negative number if <var>A</var> is before <var>B</var>, zero if they are equal, or positive <var>A</var> is later than <var>B</var>.</short>
  2798. </element>
  2799. <!-- argument Visibility: default -->
  2800. <element name="CompareTime.A">
  2801. <short>First time to compare</short>
  2802. </element>
  2803. <!-- argument Visibility: default -->
  2804. <element name="CompareTime.B">
  2805. <short>Second time to compare</short>
  2806. </element>
  2807. <!-- function Visibility: default -->
  2808. <element name="SameDateTime">
  2809. <short>Check whether two <var>TDateTime</var> values have the same date and time parts.</short>
  2810. </element>
  2811. <!-- function result Visibility: default -->
  2812. <element name="SameDateTime.Result">
  2813. <short><var>True</var> if <var>A</var> and <var>B</var> have the same date and time parts, <var>False</var> if not.</short>
  2814. </element>
  2815. <!-- argument Visibility: default -->
  2816. <element name="SameDateTime.A">
  2817. <short>First DateTime value</short>
  2818. </element>
  2819. <!-- argument Visibility: default -->
  2820. <element name="SameDateTime.B">
  2821. <short>Second DateTime value</short>
  2822. </element>
  2823. <!-- function Visibility: default -->
  2824. <element name="SameDate">
  2825. <short>Check whether two <var>TDateTime</var> values have the same date part.</short>
  2826. </element>
  2827. <!-- function result Visibility: default -->
  2828. <element name="SameDate.Result">
  2829. <short><var>True</var> if <var>A</var> and <var>B</var> have the same time part, <var>False</var> if not</short>
  2830. </element>
  2831. <!-- argument Visibility: default -->
  2832. <element name="SameDate.A">
  2833. <short>First DateTime value</short>
  2834. </element>
  2835. <!-- argument Visibility: default -->
  2836. <element name="SameDate.B">
  2837. <short>Second DateTime value</short>
  2838. </element>
  2839. <!-- function Visibility: default -->
  2840. <element name="SameTime">
  2841. <short>Check whether two <var>TDateTime</var> values have the same time part.</short>
  2842. </element>
  2843. <!-- function result Visibility: default -->
  2844. <element name="SameTime.Result">
  2845. <short><var>True</var> if <var>A</var> and <var>B</var> have the same time part, <var>False</var> if not.</short>
  2846. </element>
  2847. <!-- argument Visibility: default -->
  2848. <element name="SameTime.A">
  2849. <short>First DateTime value</short>
  2850. </element>
  2851. <!-- argument Visibility: default -->
  2852. <element name="SameTime.B">
  2853. <short>Second DateTime value</short>
  2854. </element>
  2855. <!-- function Visibility: default -->
  2856. <element name="NthDayOfWeek">
  2857. <short>Calculate which occurrence of weekday in the month a given day represents</short>
  2858. </element>
  2859. <!-- function result Visibility: default -->
  2860. <element name="NthDayOfWeek.Result">
  2861. <short>Occurrence of weekday in the month of <var>AValue</var>.</short>
  2862. </element>
  2863. <!-- argument Visibility: default -->
  2864. <element name="NthDayOfWeek.AValue">
  2865. <short>Date to check.</short>
  2866. </element>
  2867. <!-- procedure Visibility: default -->
  2868. <element name="DecodeDayOfWeekInMonth">
  2869. <short>Decode a DateTime value in year, month, day of week parts</short>
  2870. </element>
  2871. <!-- argument Visibility: default -->
  2872. <element name="DecodeDayOfWeekInMonth.AValue">
  2873. <short>DateTime to decode</short>
  2874. </element>
  2875. <!-- argument Visibility: default -->
  2876. <element name="DecodeDayOfWeekInMonth.AYear">
  2877. <short>Returns the year part of <var>AValue</var>.</short>
  2878. </element>
  2879. <!-- argument Visibility: default -->
  2880. <element name="DecodeDayOfWeekInMonth.AMonth">
  2881. <short>Returns the month part of <var>AValue</var>.</short>
  2882. </element>
  2883. <!-- argument Visibility: default -->
  2884. <element name="DecodeDayOfWeekInMonth.ANthDayOfWeek">
  2885. <short>Returns which <var>ADayofWeek</var> of <var>AValue</var>.</short>
  2886. </element>
  2887. <!-- argument Visibility: default -->
  2888. <element name="DecodeDayOfWeekInMonth.ADayOfWeek">
  2889. <short>Returns the day of week part of <var>AValue</var>.</short>
  2890. </element>
  2891. <!-- function Visibility: default -->
  2892. <element name="EncodeDayOfWeekInMonth">
  2893. <short>Encodes a year, month, week, day of week specification to a <var>TDateTime</var> value</short>
  2894. </element>
  2895. <!-- function result Visibility: default -->
  2896. <element name="EncodeDayOfWeekInMonth.Result">
  2897. <short><var>TDateTime</var> value representing <var>AYear</var> , <var>AMonth</var><var>ANthDayOfWeek</var> .and <var>ADayOfWeek</var>.</short>
  2898. </element>
  2899. <!-- argument Visibility: default -->
  2900. <element name="EncodeDayOfWeekInMonth.AYear">
  2901. <short>Year</short>
  2902. </element>
  2903. <!-- argument Visibility: default -->
  2904. <element name="EncodeDayOfWeekInMonth.AMonth">
  2905. <short>Month in the year</short>
  2906. </element>
  2907. <!-- argument Visibility: default -->
  2908. <element name="EncodeDayOfWeekInMonth.ANthDayOfWeek">
  2909. <short>Week in the month</short>
  2910. </element>
  2911. <!-- argument Visibility: default -->
  2912. <element name="EncodeDayOfWeekInMonth.ADayOfWeek">
  2913. <short>Day of the week</short>
  2914. </element>
  2915. <!-- function Visibility: default -->
  2916. <element name="TryEncodeDayOfWeekInMonth">
  2917. <short>Encode a year, month, week, day of week triplet to a <var>TDateTime</var> value</short>
  2918. </element>
  2919. <!-- function result Visibility: default -->
  2920. <element name="TryEncodeDayOfWeekInMonth.Result">
  2921. <short><var>True</var> if the encoding was succesful, <var>False</var> if not.</short>
  2922. </element>
  2923. <!-- argument Visibility: default -->
  2924. <element name="TryEncodeDayOfWeekInMonth.AYear">
  2925. <short>Year</short>
  2926. </element>
  2927. <!-- argument Visibility: default -->
  2928. <element name="TryEncodeDayOfWeekInMonth.AMonth">
  2929. <short>Month in year</short>
  2930. </element>
  2931. <!-- argument Visibility: default -->
  2932. <element name="TryEncodeDayOfWeekInMonth.ANthDayOfWeek">
  2933. <short>Day of week occurrence</short>
  2934. </element>
  2935. <!-- argument Visibility: default -->
  2936. <element name="TryEncodeDayOfWeekInMonth.ADayOfWeek">
  2937. <short>Day of week</short>
  2938. </element>
  2939. <!-- argument Visibility: default -->
  2940. <element name="TryEncodeDayOfWeekInMonth.AValue">
  2941. <short>Resulting TDateTime value</short>
  2942. </element>
  2943. <!-- argument Visibility: default -->
  2944. <element name="InvalidDateTimeError.ABaseDate">
  2945. <short>Base date time to use when creating the string representing the date/time. Default 0</short>
  2946. </element>
  2947. <!-- procedure Visibility: default -->
  2948. <element name="InvalidDateTimeError">
  2949. <short>Raise an <var>EConvertError</var> about an invalid date-time specification.</short>
  2950. </element>
  2951. <!-- argument Visibility: default -->
  2952. <element name="InvalidDateTimeError.AYear">
  2953. <short>Year</short>
  2954. </element>
  2955. <!-- argument Visibility: default -->
  2956. <element name="InvalidDateTimeError.AMonth">
  2957. <short>Month in the year</short>
  2958. </element>
  2959. <!-- argument Visibility: default -->
  2960. <element name="InvalidDateTimeError.ADay">
  2961. <short>Day of the month</short>
  2962. </element>
  2963. <!-- argument Visibility: default -->
  2964. <element name="InvalidDateTimeError.AHour">
  2965. <short>Hour of the day</short>
  2966. </element>
  2967. <!-- argument Visibility: default -->
  2968. <element name="InvalidDateTimeError.AMinute">
  2969. <short>Minute of the hour</short>
  2970. </element>
  2971. <!-- argument Visibility: default -->
  2972. <element name="InvalidDateTimeError.ASecond">
  2973. <short>Seconds in the minute</short>
  2974. </element>
  2975. <!-- argument Visibility: default -->
  2976. <element name="InvalidDateTimeError.AMilliSecond">
  2977. <short>Milliseconds in second</short>
  2978. </element>
  2979. <!-- procedure Visibility: default -->
  2980. <element name="InvalidDateWeekError">
  2981. <short>Raise an EConvertError with an invalid Year, WeekOfyear and DayOfWeek specification</short>
  2982. </element>
  2983. <!-- procedure Visibility: default -->
  2984. <element name="InvalidDateDayError">
  2985. <short>Raise an <var>EConvertError</var> exception when a day is not a valid day of a year.</short>
  2986. </element>
  2987. <!-- argument Visibility: default -->
  2988. <element name="InvalidDateDayError.AYear">
  2989. <short>Year</short>
  2990. </element>
  2991. <!-- argument Visibility: default -->
  2992. <element name="InvalidDateDayError.ADayOfYear">
  2993. <short>Invalid day of the year.</short>
  2994. </element>
  2995. <!-- procedure Visibility: default -->
  2996. <element name="InvalidDateMonthWeekError">
  2997. <short>Raise an <var>EConvertError</var> exception when a Year,Month,WeekOfMonth,DayofWeek is invalid.</short>
  2998. </element>
  2999. <!-- argument Visibility: default -->
  3000. <element name="InvalidDateMonthWeekError.AYear">
  3001. <short>Year</short>
  3002. </element>
  3003. <!-- argument Visibility: default -->
  3004. <element name="InvalidDateMonthWeekError.AMonth">
  3005. <short>Month of the year</short>
  3006. </element>
  3007. <!-- argument Visibility: default -->
  3008. <element name="InvalidDateMonthWeekError.AWeekOfMonth">
  3009. <short>Week of the month</short>
  3010. </element>
  3011. <!-- argument Visibility: default -->
  3012. <element name="InvalidDateMonthWeekError.ADayOfWeek">
  3013. <short>Day of the week</short>
  3014. </element>
  3015. <!-- procedure Visibility: default -->
  3016. <element name="InvalidDayOfWeekInMonthError">
  3017. <short>Raise an <var>EConvertError</var> exception when a Year,Month,NthDayofWeek,DayofWeek is invalid.</short>
  3018. </element>
  3019. <!-- argument Visibility: default -->
  3020. <element name="InvalidDayOfWeekInMonthError.AYear">
  3021. <short>Year</short>
  3022. </element>
  3023. <!-- argument Visibility: default -->
  3024. <element name="InvalidDayOfWeekInMonthError.AMonth">
  3025. <short>Month in the year</short>
  3026. </element>
  3027. <!-- argument Visibility: default -->
  3028. <element name="InvalidDayOfWeekInMonthError.ANthDayOfWeek">
  3029. <short>Nth occurrence of day of week.</short>
  3030. </element>
  3031. <!-- argument Visibility: default -->
  3032. <element name="InvalidDayOfWeekInMonthError.ADayOfWeek">
  3033. <short>Day of week.</short>
  3034. </element>
  3035. <!-- function Visibility: default -->
  3036. <element name="DateTimeToJulianDate">
  3037. <short>Converts a TDateTime value to a Julian date representation</short>
  3038. </element>
  3039. <!-- function result Visibility: default -->
  3040. <element name="DateTimeToJulianDate.Result">
  3041. <short>Julian representation of <var>AValue</var>.</short>
  3042. </element>
  3043. <!-- argument Visibility: default -->
  3044. <element name="DateTimeToJulianDate.AValue">
  3045. <short>DateTime value to convert to Julian representation</short>
  3046. </element>
  3047. <!-- function Visibility: default -->
  3048. <element name="JulianDateToDateTime">
  3049. <short>Convert a Julian date representation to a <var>TDateTime</var> value.</short>
  3050. </element>
  3051. <!-- function result Visibility: default -->
  3052. <element name="JulianDateToDateTime.Result">
  3053. <short>Resulting <var>TDateTime</var></short>
  3054. </element>
  3055. <!-- argument Visibility: default -->
  3056. <element name="JulianDateToDateTime.AValue">
  3057. <short>Date in Julian notation</short>
  3058. </element>
  3059. <!-- function Visibility: default -->
  3060. <element name="TryJulianDateToDateTime">
  3061. <short>Convert a Julian date representation to a <var>TDateTime</var> value.</short>
  3062. </element>
  3063. <!-- function result Visibility: default -->
  3064. <element name="TryJulianDateToDateTime.Result">
  3065. <short><var>True</var> if the conversion was succesful, <var>False</var> if not.</short>
  3066. </element>
  3067. <!-- argument Visibility: default -->
  3068. <element name="TryJulianDateToDateTime.AValue">
  3069. <short>Date in Julian notation</short>
  3070. </element>
  3071. <!-- argument Visibility: default -->
  3072. <element name="TryJulianDateToDateTime.ADateTime">
  3073. <short>Resulting <var>TDateTime</var> equivalent</short>
  3074. </element>
  3075. <!-- function Visibility: default -->
  3076. <element name="DateTimeToModifiedJulianDate">
  3077. <short>Convert a <var>TDateTime</var> value to a modified Julian date representation</short>
  3078. </element>
  3079. <!-- function result Visibility: default -->
  3080. <element name="DateTimeToModifiedJulianDate.Result">
  3081. <short>Modified Julian representation of <var>AValue</var>.</short>
  3082. </element>
  3083. <!-- argument Visibility: default -->
  3084. <element name="DateTimeToModifiedJulianDate.AValue">
  3085. <short>DateTime value to convert to Modified Julian representation</short>
  3086. </element>
  3087. <!-- function Visibility: default -->
  3088. <element name="ModifiedJulianDateToDateTime">
  3089. <short>Convert a modified Julian date representation to a <var>TDateTime</var> value.</short>
  3090. </element>
  3091. <!-- function result Visibility: default -->
  3092. <element name="ModifiedJulianDateToDateTime.Result">
  3093. <short><var>AValue</var> in modified Julian date notation.</short>
  3094. </element>
  3095. <!-- argument Visibility: default -->
  3096. <element name="ModifiedJulianDateToDateTime.AValue">
  3097. <short>Date to convert</short>
  3098. </element>
  3099. <!-- function Visibility: default -->
  3100. <element name="TryModifiedJulianDateToDateTime">
  3101. <short>Convert a modified Julian date representation to a <var>TDateTime</var> value.</short>
  3102. </element>
  3103. <!-- function result Visibility: default -->
  3104. <element name="TryModifiedJulianDateToDateTime.Result">
  3105. <short><var>True</var> if the conversion was succesful, <var>False</var> if not.</short>
  3106. </element>
  3107. <!-- argument Visibility: default -->
  3108. <element name="TryModifiedJulianDateToDateTime.AValue">
  3109. <short>Modified Julian date to convert</short>
  3110. </element>
  3111. <!-- argument Visibility: default -->
  3112. <element name="TryModifiedJulianDateToDateTime.ADateTime">
  3113. <short><var>AValue</var> as a <var>TDateTime</var> value.</short>
  3114. </element>
  3115. <!-- function Visibility: default -->
  3116. <element name="DateTimeToUnix">
  3117. <short>Convert a <var>TDateTime</var> value to Unix epoch time</short>
  3118. </element>
  3119. <!-- function result Visibility: default -->
  3120. <element name="DateTimeToUnix.Result">
  3121. <short>Unix epoch time corresponding to <var>AValue</var></short>
  3122. </element>
  3123. <!-- argument Visibility: default -->
  3124. <element name="DateTimeToUnix.AValue">
  3125. <short>DateTime value to convert</short>
  3126. </element>
  3127. <!-- function Visibility: default -->
  3128. <element name="UnixToDateTime">
  3129. <short>Convert Unix epoch time to a <var>TDateTime</var> value</short>
  3130. </element>
  3131. <!-- function result Visibility: default -->
  3132. <element name="UnixToDateTime.Result">
  3133. <short><var>AValue</var> as a <var>TDateTime</var> value.</short>
  3134. </element>
  3135. <!-- argument Visibility: default -->
  3136. <element name="UnixToDateTime.AValue">
  3137. <short>Date to convert.</short>
  3138. </element>
  3139. </module>
  3140. <!-- dateutils -->
  3141. </package>
  3142. </fpdoc-descriptions>