| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788 |
- <?xml version="1.0"?>
- <fpdoc-descriptions>
- <package name="rtl">
- <!--
- ====================================================================
- dateutils
- ====================================================================
- -->
- <module name="dateutils">
- <short>Date/Time manipulation routines.</short>
- <descr/>
- <!-- unresolved type reference Visibility: default -->
- <element name="SysUtils">
- <short>Exception support</short>
- </element>
- <!-- unresolved type reference Visibility: default -->
- <element name="Math">
- <short>Math support</short>
- </element>
- <!-- unresolved type reference Visibility: default -->
- <element name="Types">
- <short>Basic types</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="DaysPerWeek">
- <short>Number of days in a week.</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="WeeksPerFortnight">
- <short>Number of weeks in fortnight</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="MonthsPerYear">
- <short>Number of months in a year</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="YearsPerDecade">
- <short>Number of years in a decade</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="YearsPerCentury">
- <short>Number of years in a century</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="YearsPerMillennium">
- <short>Number of years in a millenium</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="DayMonday">
- <short>ISO day number for Monday</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="DayTuesday">
- <short>ISO day number for Tuesday</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="DayWednesday">
- <short>ISO day number for Wednesday</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="DayThursday">
- <short>ISO day number for Thursday</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="DayFriday">
- <short>ISO day number for Friday</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="DaySaturday">
- <short>ISO day number for Saturday</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="DaySunday">
- <short>ISO day number for Sunday</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="OneHour">
- <short>One hour as a fraction of a day (suitable for TDateTime)</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="OneMinute">
- <short>One minute as a fraction of a day (suitable for TDateTime)</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="OneSecond">
- <short>One second as a fraction of a day (suitable for TDateTime)</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="OneMillisecond">
- <short>One millisecond as a fraction of a day (suitable for TDateTime)</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="DaysPerYear">
- <short>Array with number of days in a year. The boolean index indicates whether it is a leap year or not.</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="RecodeLeaveFieldAsIs">
- <short>Bitmask deciding what to do with each TDateTime field in recode routines</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="ApproxDaysPerMonth">
- <short>Average number of days in a month, measured over a year. Used in <link id="MonthsBetween"/>.</short>
- </element>
- <!-- constant Visibility: default -->
- <element name="ApproxDaysPerYear">
- <short>Average number of days in a year, measured over 4 years. Used in <link id="YearsBetween"/>.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DateOf">
- <short>Extract the date part from a DateTime indication.</short>
- <descr>
- <p>
- <var>DateOf</var> extracts the date part from <var>AValue</var> and returns
- the result.
- </p>
- <p>
- Since the <var>TDateTime</var> is actually a double with the date part
- encoded in the integer part, this operation corresponds to a call to
- <var>Trunc</var>.
- </p>
- </descr>
- <seealso>
- <link id="TimeOf"/>
- <link id="YearOf"/>
- <link id="MonthOf"/>
- <link id="DayOf"/>
- <link id="HourOf"/>
- <link id="MinuteOf"/>
- <link id="SecondOf"/>
- <link id="MilliSecondOf"/>
- </seealso>
- <example file="datutex/ex1"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="DateOf.Result">
- <short>Date part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DateOf.AValue">
- <short>Datetime to extract date from</short>
- </element>
- <!-- function Visibility: default -->
- <element name="TimeOf">
- <short>Extract the time part from a DateTime indication.</short>
- <descr>
- <p>
- <var>TimeOf</var> extracts the time part from <var>AValue</var> and returns
- the result.
- </p>
- <p>
- Since the <var>TDateTime</var> is actually a double with the time part
- encoded in the fractional part, this operation corresponds to a call to
- <var>Frac</var>.
- </p>
- </descr>
- <seealso>
- <link id="DateOf"/>
- <link id="YearOf"/>
- <link id="MonthOf"/>
- <link id="DayOf"/>
- <link id="HourOf"/>
- <link id="MinuteOf"/>
- <link id="SecondOf"/>
- <link id="MilliSecondOf"/>
- </seealso>
- <example file="datutex/ex2"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TimeOf.Result">
- <short>Time part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TimeOf.AValue">
- <short>Datetime to extract time from</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IsInLeapYear">
- <short>Determine whether a date is in a leap year.</short>
- <descr>
- <var>IsInLeapYear</var> returns <var>True</var> if the year part of <var>AValue</var>
- is leap year, or <var>False</var> if not.
- </descr>
- <seealso>
- <link id="YearOf"/>
- <link id="IsPM"/>
- <link id="IsToday"/>
- <link id="IsSameDay"/>
- </seealso>
- <example file="datutex/ex3"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="IsInLeapYear.Result">
- <short><var>True</var> if <var>AValue</var> is in a leap year, <var>False</var> if not.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsInLeapYear.AValue">
- <short>Date to be checked.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IsPM">
- <short>Determine whether a time is PM or AM.</short>
- <descr>
- <var>IsPM</var> returns <var>True</var> if the time part of
- <var>AValue</var> is later then 12:00 (PM, or afternoon).
- </descr>
- <seealso>
- <link id="YearOf"/>
- <link id="IsInLeapYear"/>
- <link id="IsToday"/>
- <link id="IsSameDay"/>
- </seealso>
- <example file="datutex/ex4"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="IsPM.Result">
- <short><var>True</var> if the time part of <var>AValue</var> is PM (afternoon).</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsPM.AValue">
- <short>Time to check.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IsValidDate">
- <short>Check whether a set of values is a valid date indication.</short>
- <descr>
- <p>
- <var>IsValidDate</var> returns <var>True</var> when the values <var>AYear</var>,
- <var>AMonth</var>, <var>ADay</var> form a valid date indication. If one of
- the values is not valid (e.g. the day is invalid or does not exist in that
- particular month), <var>False</var> is returned.
- </p>
- <p>
- <var>AYear</var> must be in the range 1..9999 to be valid.
- </p>
- </descr>
- <example file="datutex/ex5"/>
- <seealso>
- <link id="IsValidTime"/>
- <link id="IsValidDateTime"/>
- <link id="IsValidDateDay"/>
- <link id="IsValidDateWeek"/>
- <link id="IsValidDateMonthWeek"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="IsValidDate.Result">
- <short><var>True</var> if the given values form a valid date, <var>False</var> if not. </short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDate.AYear">
- <short>Year value</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDate.AMonth">
- <short>Month in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDate.ADay">
- <short>Day in the month</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IsValidTime">
- <short>Check whether a set of values is a valid time indication.</short>
- <descr/>
- </element>
- <!-- function result Visibility: default -->
- <element name="IsValidTime.Result">
- <short><var>True</var> if the given values form a valid time, <var>False</var> if not.</short>
- <descr>
- <var>IsValidTime</var> returns <var>True</var> when the values
- <var>AHour</var>,
- <var>AMinute</var>, <var>ASecond</var> and <var>AMilliSecond</var> form a valid
- time indication. If one of the values is not valid (e.g. the seconds are
- larger than 60), <var>False</var> is returned.
- </descr>
- <example file="datutex/ex6"/>
- <seealso>
- <link id="IsValidDate"/>
- <link id="IsValidDateTime"/>
- <link id="IsValidDateDay"/>
- <link id="IsValidDateWeek"/>
- <link id="IsValidDateMonthWeek"/>
- </seealso>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidTime.AHour">
- <short>Hour of the day.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidTime.AMinute">
- <short>Minute in the hour</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidTime.ASecond">
- <short>Second in the minute</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidTime.AMilliSecond">
- <short>Milliseconds in the second</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IsValidDateTime">
- <short>Check whether a set of values is a valid date and time indication.</short>
- <descr>
- <p>
- <var>IsValidTime</var> returns <var>True</var> when the values
- <var>AYear</var>, <var>AMonth</var>, <var>ADay</var>,
- <var>AHour</var>, <var>AMinute</var>, <var>ASecond</var>
- and <var>AMilliSecond</var> form a valid date and time indication.
- If one of the values is not valid (e.g. the seconds are larger than 60), <var>False</var> is returned.
- </p>
- <p>
- <var>AYear</var> must be in the range 1..9999 to be valid.
- </p>
- </descr>
- <example file="datutex/ex7"/>
- <seealso>
- <link id="IsValidDate"/>
- <link id="IsValidTime"/>
- <link id="IsValidDateDay"/>
- <link id="IsValidDateWeek"/>
- <link id="IsValidDateMonthWeek"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="IsValidDateTime.Result">
- <short><var>True</var> if the given values form a valid date/time pair, <var>False</var> if not.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateTime.AYear">
- <short>Year value</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateTime.AMonth">
- <short>Month in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateTime.ADay">
- <short>Day in the month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateTime.AHour">
- <short>Hour of the day</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateTime.AMinute">
- <short>Minute in the hour</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateTime.ASecond">
- <short>Second in the minute</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateTime.AMilliSecond">
- <short>Milliseconds in the second</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IsValidDateDay">
- <short>Check whether a given year/day of year combination is a valid date.</short>
- <descr>
- <p>
- <var>IsValidDateDay</var> returns <var>True</var> if <var>AYear</var> and
- <var>ADayOfYear</var> form a valid date indication, or <var>False</var>
- otherwise.
- </p>
- <p>
- <var>AYear</var> must be in the range 1..9999 to be valid.
- </p>
- <p>
- The <var>ADayOfYear</var> value is checked to see whether it falls within the valid range of
- dates for <var>AYear</var>.
- </p>
- </descr>
- <example file="datutex/ex9"/>
- <seealso>
- <link id="IsValidDate"/>
- <link id="IsValidTime"/>
- <link id="IsValidDateTime"/>
- <link id="IsValidDateWeek"/>
- <link id="IsValidDateMonthWeek"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="IsValidDateDay.Result">
- <short><var>True</var> if the given combination is a valid date, <var>False</var> otherwise.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateDay.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateDay.ADayOfYear">
- <short>Day in the year</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IsValidDateWeek">
- <short>Check whether a given year/week/day of the week combination is a valid day.</short>
- <descr>
- <p>
- <var>IsValidDateWeek</var> returns <var>True</var> if <var>AYear</var>,
- <var>AWeekOfYear</var> and <var>ADayOfWeek</var> form a valid date indication,
- or <var>False</var> otherwise.
- </p>
- <p>
- <var>AYear</var> must be in the range 1..9999 to be valid.
- </p>
- <p>
- The <var>ADayOfWeek</var>,<var>ADayOfWeek</var> values are checked to see whether
- the combination falls within the valid range of weeks for <var>AYear</var>.
- </p>
- </descr>
- <example file="datutex/ex10"/>
- <seealso>
- <link id="IsValidDate"/>
- <link id="IsValidTime"/>
- <link id="IsValidDateTime"/>
- <link id="IsValidDateDay"/>
- <link id="IsValidDateMonthWeek"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="IsValidDateWeek.Result">
- <short><var>True</var> if the given combination is a valid date, <var>False</var> otherwise.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateWeek.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateWeek.AWeekOfYear">
- <short>Week in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateWeek.ADayOfWeek">
- <short>Day in the week</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IsValidDateMonthWeek">
- <short>Check whether a given year/month/week/day of the week combination is a valid day</short>
- <descr>
- <p>
- <var>IsValidDateMonthWeek</var> returns <var>True</var> if <var>AYear</var>,
- <var>AMonth</var> <var>AWeekOfMonth</var> and <var>ADayOfWeek</var> form a valid date indication,
- or <var>False</var> otherwise.
- </p>
- <p>
- <var>AYear</var> must be in the range 1..9999 to be valid.
- </p>
- <p>
- The <var>AWeekOfMonth</var>,<var>ADayOfWeek</var> values are checked to see whether
- the combination falls within the valid range of weeks for the
- <var>AYear</var>,<var>AMonth</var> combination.
- </p>
- </descr>
- <example file="datutex/ex11"/>
- <seealso>
- <link id="IsValidDate"/>
- <link id="IsValidTime"/>
- <link id="IsValidDateTime"/>
- <link id="IsValidDateDay"/>
- <link id="IsValidDateWeek"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="IsValidDateMonthWeek.Result">
- <short><var>True</var> if the given combination is a valid date, <var>False</var> otherwise.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateMonthWeek.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateMonthWeek.AMonth">
- <short>Month of the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateMonthWeek.AWeekOfMonth">
- <short>Week of the month.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsValidDateMonthWeek.ADayOfWeek">
- <short>Day in the week.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WeeksInYear">
- <short>return the number of weeks in the year, given a date</short>
- <descr>
- <p>
- <var>WeeksInYear</var> returns the number of weeks in the year part of
- <var>AValue</var>. The return value is either 52 or 53.
- </p>
- <remark>
- The first week of the year is determined according to the ISO 8601 standard:
- It is the first week that has at least 4 days in it, i.e. it includes a
- thursday.
- </remark>
- </descr>
- <seealso>
- <link id="WeeksInAYear"/>
- <link id="DaysInYear"/>
- <link id="DaysInAYear"/>
- <link id="DaysInMonth"/>
- <link id="DaysInAMonth"/>
- </seealso>
- <example file="datutex/ex12"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="WeeksInYear.Result">
- <short>Number of weeks.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeeksInYear.AValue">
- <short>Day in the year.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WeeksInAYear">
- <short>Return the number of weeks in a given year</short>
- <descr>
- <p>
- <var>WeeksInAYear</var> returns the number of weeks in the year
- <var>AYear</var>. The return value is either 52 or 53.
- </p>
- <remark>
- The first week of the year is determined according to the ISO 8601 standard:
- It is the first week that has at least 4 days in it, i.e. it includes a
- thursday.
- </remark>
- </descr>
- <seealso>
- <link id="WeeksInYear"/>
- <link id="DaysInYear"/>
- <link id="DaysInAYear"/>
- <link id="DaysInMonth"/>
- <link id="DaysInAMonth"/>
- </seealso>
- <example file="datutex/ex13"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="WeeksInAYear.Result">
- <short>Number of weeks in <var>AYear</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeeksInAYear.AYear">
- <short>A (valid) year.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DaysInYear">
- <short>Return the number of days in the year in which a date occurs.</short>
- <descr>
- <p>
- <var>daysInYear</var> returns the number of days in the year part of
- <var>AValue</var>. The return value is either 365 or 366.
- </p>
- </descr>
- <seealso>
- <link id="WeeksInAYear"/>
- <link id="WeeksInYear"/>
- <link id="DaysInAYear"/>
- <link id="DaysInMonth"/>
- <link id="DaysInAMonth"/>
- </seealso>
- <example file="datutex/ex14"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="DaysInYear.Result">
- <short>Number of days in the year in which <var>AValue</var> occurs.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DaysInYear.AValue">
- <short>Date in year of which to calculate the number of days.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DaysInAYear">
- <short>Number of days in a particular year.</short>
- <descr>
- <p>
- <var>DaysInAYear</var> returns the number of weeks in the year
- <var>AYear</var>. The return value is either 365 or 366.
- </p>
- </descr>
- <seealso>
- <link id="WeeksInAYear"/>
- <link id="WeeksInYear"/>
- <link id="DaysInYear"/>
- <link id="DaysInMonth"/>
- <link id="DaysInAMonth"/>
- </seealso>
- <example file="datutex/ex15"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="DaysInAYear.Result">
- <short>Number of days in year <var>AYear</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DaysInAYear.AYear">
- <short>Year to return the number of days from</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DaysInMonth">
- <short>Return the number of days in the month in which a date occurs.</short>
- <descr>
- <p>
- <var>DaysInMonth</var> returns the number of days in the month in which
- <var>AValue</var> falls. The return value takes leap years into account.
- </p>
- </descr>
- <seealso>
- <link id="WeeksInAYear"/>
- <link id="WeeksInYear"/>
- <link id="DaysInYear"/>
- <link id="DaysInAYear"/>
- <link id="DaysInAMonth"/>
- </seealso>
- <example file="datutex/ex16"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="DaysInMonth.Result">
- <short>Number of days in the month in which <var>AValue</var> occurs.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DaysInMonth.AValue">
- <short>Date in month of which to calculate the number of days.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DaysInAMonth">
- <short>Number of days in a month of a certain year.</short>
- <descr>
- <p>
- <var>DaysInYMonth</var> returns the number of days in the month
- <var>AMonth</var> in the year<var>AYear</var>.
- The return value takes leap years into account.
- </p>
- </descr>
- <seealso>
- <link id="WeeksInAYear"/>
- <link id="WeeksInYear"/>
- <link id="DaysInYear"/>
- <link id="DaysInAYear"/>
- <link id="DaysInMonth"/>
- </seealso>
- <example file="datutex/ex17"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="DaysInAMonth.Result">
- <short>The number of days in month <var>AMonth</var>, in year <var>AYear</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DaysInAMonth.AYear">
- <short>Year in which the month occurs.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DaysInAMonth.AMonth">
- <short>Month of which the number of days should be returned.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="Today">
- <short>Return the current date</short>
- <descr>
- <p>
- <var>Today</var> is an alias for the <link
- id="#rtl.sysutils.Date">Date</link> function in the <link
- id="#rtl.sysutils">sysutils</link> unit.
- </p>
- <p>
- For an example, see <link id="Yesterday"/>
- </p>
- </descr>
- <seealso>
- <link id="#rtl.sysutils.Date">Date</link>
- <link id="Yesterday"/>
- <link id="Tomorrow"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="Today.Result">
- <short>Current day as <var>TDateTime</var>.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="Yesterday">
- <short>Return the previous day.</short>
- <descr>
- <var>Yesterday</var> returns yesterday's date. Yesterday is determined from
- the system clock, i.e. it is <link id="Today"/> -1.
- </descr>
- <seealso>
- <link id="Today"/>
- <link id="Tomorrow"/>
- </seealso>
- <example file="datutex/ex18"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="Yesterday.Result">
- <short>Previous day as <var>TDateTime</var>.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="Tomorrow">
- <short>Return the next day</short>
- <descr>
- <var>Tomorrow</var> returns tomorrow's date. Tomorrow is determined from
- the system clock, i.e. it is <link id="Today"/> +1.
- </descr>
- <seealso>
- <link id="Today"/>
- <link id="Yesterday"/>
- </seealso>
- <example file="datutex/ex19"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="Tomorrow.Result">
- <short>Next day as <var>TDateTime</var>.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IsToday">
- <short>Check whether a given date is today.</short>
- <descr>
- <var>IsToday</var> returns <var>True</var> if <var>AValue</var> is today's
- date, and <var>False</var> otherwise.
- </descr>
- <seealso>
- <link id="Today"/>
- <link id="Yesterday"/>
- <link id="Tomorrow"/>
- <link id="IsSameDay"/>
- </seealso>
- <example file="datutex/ex20"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="IsToday.Result">
- <short><var>True</var> if <var>AValue</var> is today, <var>False</var> otherwise.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsToday.AValue">
- <short>Date to check, may contain a time part.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IsSameDay">
- <short>Check if two date/time indications are the same day.</short>
- <descr>
- <var>IsSameDay</var> checks whether <var>AValue</var> and <var>ABasis</var>
- have the same date part, and returns <var>True</var> if they do,
- <var>False</var> if not.
- </descr>
- <seealso>
- <link id="Today"/>
- <link id="Yesterday"/>
- <link id="Tomorrow"/>
- <link id="IsToday"/>
- </seealso>
- <example file="datutex/ex21"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="IsSameDay.Result">
- <short><var>True</var> if <var>AValue</var> and <var>ABasis</var> are on the same
- day, <var>False</var> otherwise..</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsSameDay.AValue">
- <short>First date/time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IsSameDay.ABasis">
- <short>Second date/time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="PreviousDayOfWeek">
- <short>Given a day of the week, return the previous day of the week.</short>
- <descr>
- <p>
- <var>PreviousDayOfWeek</var> returns the previous day of the week. If the
- current day is the first day of the week (1) then the last day will be
- returned (7).
- </p>
- <remark>
- Note that the days of the week are in ISO notation, i.e. 1-based.
- </remark>
- </descr>
- <seealso>
- <link id="Yesterday"/>
- </seealso>
- <example file="datutex/ex22"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="PreviousDayOfWeek.Result">
- <short>The day of the week prior to <var>DayOfWeek</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="PreviousDayOfWeek.DayOfWeek">
- <short>Day of the week.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="YearOf">
- <short>Extract the year from a given date.</short>
- <descr>
- <var>YearOf</var> returns the year part of the <var>AValue</var> date/time
- indication. It is a number between 1 and 9999.
- </descr>
- <seealso>
- <link id="MonthOf"/>
- <link id="DayOf"/>
- <link id="WeekOf"/>
- <link id="HourOf"/>
- <link id="MinuteOf"/>
- <link id="SecondOf"/>
- <link id="MilliSecondOf"/>
- </seealso>
- <example file="datutex/ex23"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="YearOf.Result">
- <short>Year part of <var>AValue</var></short>
- <descr/>
- </element>
- <!-- argument Visibility: default -->
- <element name="YearOf.AValue">
- <short>Date to extract year from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MonthOf">
- <short>Extract the month from a given date.</short>
- <descr>
- <p>
- <var>MonthOf</var> returns the month part of the <var>AValue</var> date/time
- indication. It is a number between 1 and 12.
- </p>
- <p>
- For an example, see <link id="YearOf"/>
- </p>
- </descr>
- <seealso>
- <link id="YearOf"/>
- <link id="DayOf"/>
- <link id="WeekOf"/>
- <link id="HourOf"/>
- <link id="MinuteOf"/>
- <link id="SecondOf"/>
- <link id="MilliSecondOf"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="MonthOf.Result">
- <short>Month part of <var>AValue</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MonthOf.AValue">
- <short>Date to extract month from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WeekOf">
- <short>Extract week (of the year) from a given date.</short>
- <descr>
- <p>
- <var>WeekOf</var> returns the week-of-the-year part of the <var>AValue</var> date/time
- indication. It is a number between 1 and 53.
- </p>
- <p>
- For an example, see <link id="YearOf"/>
- </p>
- </descr>
- <seealso>
- <link id="YearOf"/>
- <link id="DayOf"/>
- <link id="MonthOf"/>
- <link id="HourOf"/>
- <link id="MinuteOf"/>
- <link id="SecondOf"/>
- <link id="MilliSecondOf"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="WeekOf.Result">
- <short>Week part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeekOf.AValue">
- <short>Date to extract week from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DayOf">
- <short>Extract the day (of month) part from a DateTime value</short>
- <descr>
- <p>
- <var>DayOf</var> returns the day of the month part of the <var>AValue</var> date/time
- indication. It is a number between 1 and 31.
- </p>
- <p>
- For an example, see <link id="YearOf"/>
- </p>
- </descr>
- <seealso>
- <link id="YearOf"/>
- <link id="WeekOf"/>
- <link id="MonthOf"/>
- <link id="HourOf"/>
- <link id="MinuteOf"/>
- <link id="SecondOf"/>
- <link id="MilliSecondOf"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="DayOf.Result">
- <short>Day of month part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DayOf.AValue">
- <short>Date to extract day of.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="HourOf">
- <short>Extract the hour part from a DateTime value.</short>
- <descr>
- <p>
- <var>HourOf</var> returns the hour of the day part of the <var>AValue</var> date/time
- indication. It is a number between 0 and 23.
- </p>
- <p>
- For an example, see <link id="YearOf"/>
- </p>
- </descr>
- <seealso>
- <link id="YearOf"/>
- <link id="WeekOf"/>
- <link id="MonthOf"/>
- <link id="DayOf"/>
- <link id="MinuteOf"/>
- <link id="SecondOf"/>
- <link id="MilliSecondOf"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="HourOf.Result">
- <short>Hour part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="HourOf.AValue">
- <short>Date/time value to extract hour from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MinuteOf">
- <short>Extract the minute part from a DateTime value.</short>
- <descr>
- <p>
- <var>MinuteOf</var> returns the minute of the hour part of the <var>AValue</var> date/time
- indication. It is a number between 0 and 59.
- </p>
- <p>
- For an example, see <link id="YearOf"/>
- </p>
- </descr>
- <seealso>
- <link id="YearOf"/>
- <link id="WeekOf"/>
- <link id="MonthOf"/>
- <link id="DayOf"/>
- <link id="HourOf"/>
- <link id="SecondOf"/>
- <link id="MilliSecondOf"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="MinuteOf.Result">
- <short>Minute part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MinuteOf.AValue">
- <short>Date/time value to extract minute from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SecondOf">
- <short>Extract the second part from a DateTime value.</short>
- <descr>
- <p>
- <var>SecondOf</var> returns the second of the minute part of the <var>AValue</var> date/time
- indication. It is a number between 0 and 59.
- </p>
- <p>
- For an example, see <link id="YearOf"/>
- </p>
- </descr>
- <seealso>
- <link id="YearOf"/>
- <link id="WeekOf"/>
- <link id="MonthOf"/>
- <link id="DayOf"/>
- <link id="HourOf"/>
- <link id="MinuteOf"/>
- <link id="MilliSecondOf"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="SecondOf.Result">
- <short>Second part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondOf.AValue">
- <short>Date/time value to extract second from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MilliSecondOf">
- <short>Extract the millisecond part from a DateTime value.</short>
- <descr>
- <p>
- <var>MillisecondOf</var> returns the second of the minute part of the <var>AValue</var> date/time
- indication. It is a number between 0 and 999.
- </p>
- <p>
- For an example, see <link id="YearOf"/>
- </p>
- </descr>
- <seealso>
- <link id="YearOf"/>
- <link id="WeekOf"/>
- <link id="MonthOf"/>
- <link id="DayOf"/>
- <link id="HourOf"/>
- <link id="MinuteOf"/>
- <link id="MilliSecondOf"/>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="MilliSecondOf.Result">
- <short>Millisecond part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondOf.AValue">
- <short>Date/time value to extract millisecond from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="StartOfTheYear">
- <short>Return the first day of the year, given a date in this year.</short>
- <descr>
- <var>StartOfTheYear</var> extracts the year part of <var>AValue</var> and
- returns a <var>TDateTime</var> value with the date of the first day of that year (January 1), as the
- <link id="StartOfAYear"/> function.
- </descr>
- <seealso>
- <link id="StartOfAYear"/>
- <link id="EndOfTheYear"/>
- <link id="EndOfAYear"/>
- </seealso>
- <example file="datutex/ex24"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="StartOfTheYear.Result">
- <short>First day of the year as a <var>TDateTime</var> value.</short>
- <descr/>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfTheYear.AValue">
- <short>Date in year of which to return the start </short>
- <descr/>
- </element>
- <!-- function Visibility: default -->
- <element name="EndOfTheYear">
- <short>Calculate a DateTime value representing the last day of a year, given a date in that year.</short>
- <descr>
- <var>EndOfTheYear</var> extracts the year part of <var>AValue</var> and
- returns a <var>TDateTime</var> value with the date of the last day of that year (December 31), as the
- <link id="EndOfAYear"/> function.
- </descr>
- <seealso>
- <link id="StartOfAYear"/>
- <link id="StartOfTheYear"/>
- <link id="EndOfAYear"/>
- </seealso>
- <example file="datutex/ex25"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="EndOfTheYear.Result">
- <short>DateTime value representing the end of the year in which <var>AValue</var> falls.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfTheYear.AValue">
- <short>Date in the year of which the end should be calculated</short>
- </element>
- <!-- function Visibility: default -->
- <element name="StartOfAYear">
- <short>Return the first day of a given year.</short>
- <descr>
- <var>StartOfAYear</var> returns a <var>TDateTime</var> value with the date of the first day of the year <var>AYear</var> (January 1).
- </descr>
- <seealso>
- <link id="StartOfTheYear"/>
- <link id="EndOfTheYear"/>
- <link id="EndOfAYear"/>
- </seealso>
- <example file="datutex/ex26"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="StartOfAYear.Result">
- <short>First day of <var>AYear</var> as a <var>TDateTime</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfAYear.AYear">
- <short>Year to get first date from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EndOfAYear">
- <short>Calculate a DateTime value representing the last day of a year</short>
- <descr>
- <var>StartOfAYear</var>
- returns a <var>TDateTime</var> value with the date of the last day of the year <var>AYear</var> (December 31).
- </descr>
- <seealso>
- <link id="StartOfTheYear"/>
- <link id="EndOfTheYear"/>
- <link id="EndOfAYear"/>
- </seealso>
- <example file="datutex/ex27"/>
- </element>
- <!-- function result Visibility: default -->
- <element name="EndOfAYear.Result">
- <short>DateTime representing the last day of <var>AYear</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfAYear.AYear">
- <short>Year to calculate last day from</short>
- </element>
- <!-- function Visibility: default -->
- <element name="StartOfTheMonth">
- <short>Calculate the first day of the month, given a date in that month.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="StartOfTheMonth.Result">
- <short>First day of month as a <var>TDateTime</var> value.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfTheMonth.AValue">
- <short>Date to return first of month from</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EndOfTheMonth">
- <short>Calculate a DateTime value representing the last day of the month, given a day in that month.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EndOfTheMonth.Result">
- <short>DateTime value representing the last day of the month in which <var>AVAlue</var> is a day.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfTheMonth.AValue">
- <short>Day in the month of which the last day should be returned.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="StartOfAMonth">
- <short>Return first date of month, given a year/month pair.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="StartOfAMonth.Result">
- <short>First day of the month <var>AMonth</var> in <var>AYear</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfAMonth.AYear">
- <short>A year.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfAMonth.AMonth">
- <short>Month in the year.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EndOfAMonth">
- <short>Calculate a datetime value representing the last day of the indicated month</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EndOfAMonth.Result">
- <short>DateTime value indicating the last day of <var>AMonth</var> in year <var>AYear</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfAMonth.AYear">
- <short>Year in which month occurs</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfAMonth.AMonth">
- <short>Month to calculate end of</short>
- </element>
- <!-- function Visibility: default -->
- <element name="StartOfTheWeek">
- <short>Return the first day of the week, given a date.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="StartOfTheWeek.Result">
- <short>First day of the week, in <var>TDateTime</var> format.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfTheWeek.AValue">
- <short>Day in the week.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EndOfTheWeek">
- <short>Calculate a DateTime value which represents the end of a week, given a date in that week.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EndOfTheWeek.Result">
- <short>DateTime value representing the last day of the week in which <var>AVAlue</var> is a day.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfTheWeek.AValue">
- <short>Day in the week of which the last day should be calculated.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="StartOfAWeek">
- <short>Return the first day of the week, given a year and a week in the year.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="StartOfAWeek.Result">
- <short>First day of the given week, in <var>TDateTime</var> format.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfAWeek.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfAWeek.AWeekOfYear">
- <short>Week in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfAWeek.ADayOfWeek">
- <short>Day in the week (default 1)</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EndOfAWeek">
- <short></short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EndOfAWeek.Result">
- <short></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfAWeek.AYear">
- <short></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfAWeek.AWeekOfYear">
- <short></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfAWeek.ADayOfWeek">
- <short>Day of the week</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EndOfAWeek">
- <short>Calculate a datetime value which represents the end of a specified week.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EndOfAWeek.Result">
- <short>DateTime value representing the end of the week specified by <var>AYear</var>, <var>AWeekOfYear</var> and <var>DayOfWeek</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfAWeek.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfAWeek.AWeekOfYear">
- <short>Week of the year</short>
- </element>
- <!-- function Visibility: default -->
- <element name="StartOfTheDay">
- <short>Calculate the start of the day as a DateTime value, given a moment in the day.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="StartOfTheDay.Result">
- <short>Start of the day (00:00) as DateTime value</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfTheDay.AValue">
- <short>DateTime from which to calculate start of the day.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EndOfTheDay">
- <short>Calculate a datetime value that represents the end of a given day.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EndOfTheDay.Result">
- <short>A datetime value representing the time 23:59:59.999 of the day <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfTheDay.AValue">
- <short>Day to calculate the end of</short>
- </element>
- <!-- function Visibility: default -->
- <element name="StartOfADay">
- <short>Return the start of a day as a DateTime value, given a day indication</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="StartOfADay.Result">
- <short>Start of the given day as DateTime</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfADay.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfADay.AMonth">
- <short>Month in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfADay.ADay">
- <short>Day in the month.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="StartOfADay.ADayOfYear">
- <short>Day in the year.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EndOfADay">
- <short>Calculates a DateTime value representing the end of a specified day</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EndOfADay.Result">
- <short>A datetime value representing the time 23:59:59.999 of the given day.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfADay.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfADay.AMonth">
- <short>Month in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfADay.ADay">
- <short>Day in the month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EndOfADay.ADayOfYear">
- <short>Day of the year</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MonthOfTheYear">
- <short>Extract the month of a DateTime indication.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MonthOfTheYear.Result">
- <short>The month part of <var>AValue</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MonthOfTheYear.AValue">
- <short>Date from which to extract month</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WeekOfTheYear">
- <short>Extract the week of the year (and optionally year) of a DateTime indication.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WeekOfTheYear.Result">
- <short>Week of the year in which <var>Avalue</var> falls.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeekOfTheYear.AValue">
- <short>Date from which to extract week.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeekOfTheYear.AYear">
- <short>Year part of <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="DayOfTheYear">
- <short>Extracts the day of the week from a DateTime value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="DayOfTheYear.Result">
- <short>Day of the year from <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DayOfTheYear.AValue">
- <short>DateTime to extract the day of the year from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="HourOfTheYear">
- <short>Calculate the number of hours passed since the start of the year.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="HourOfTheYear.Result">
- <short>Number of hours passed since the start of the year till <var>AValue</var> .</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="HourOfTheYear.AValue">
- <short>DateTime value for which to calculate the hour of the year</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MinuteOfTheYear">
- <short>Calculate the number of minutes elapsed since the start of the year</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MinuteOfTheYear.Result">
- <short>Number of minutes elapsed since the start of the year.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MinuteOfTheYear.AValue">
- <short>Moment in the year.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SecondOfTheYear">
- <short>Calculate the number of seconds elapsed since the start of the year.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SecondOfTheYear.Result">
- <short>Number of seconds elapsed since the start of the year.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondOfTheYear.AValue">
- <short>Moment in the year</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MilliSecondOfTheYear">
- <short>Calculate the number of milliseconds elapsed since the start of the year.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MilliSecondOfTheYear.Result">
- <short>Number of seconds elapsed since the start of the year.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondOfTheYear.AValue">
- <short>Moment in the year</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WeekOfTheMonth">
- <short>Extract the week of the month (and optionally month and year) from a DateTime value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WeekOfTheMonth.Result">
- <short>Week of the month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeekOfTheMonth.AValue">
- <short>Datetime value of which to calculate the week, month and year.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeekOfTheMonth.AYear">
- <short>Year part of <var>AValue</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeekOfTheMonth.AMonth">
- <short>Month part of <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="DayOfTheMonth">
- <short>Extract the day (of month) part of a DateTime value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="DayOfTheMonth.Result">
- <short>Day in the month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DayOfTheMonth.AValue">
- <short>Datetime value to extract day from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="HourOfTheMonth">
- <short>Calculate the number of hours passed since the start of the month.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="HourOfTheMonth.Result">
- <short>Number of hours passed since the start of the month till <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="HourOfTheMonth.AValue">
- <short>DateTime value for which to calculate the hour of the month.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MinuteOfTheMonth">
- <short>Calculate number of minutes elapsed since the start of the month.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MinuteOfTheMonth.Result">
- <short>Number of minutes elapsed since the start of the month.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MinuteOfTheMonth.AValue">
- <short>Moment in the month.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SecondOfTheMonth">
- <short>Calculate number of seconds elapsed since the start of the month.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SecondOfTheMonth.Result">
- <short>Number of seconds elapsed since the start of the month.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondOfTheMonth.AValue">
- <short>Moment in the month.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MilliSecondOfTheMonth">
- <short>Calculate number of milliseconds elapsed since the start of the month.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MilliSecondOfTheMonth.Result">
- <short>Number of milliseconds elapsed since the start of the month.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondOfTheMonth.AValue">
- <short>Moment in the month</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DayOfTheWeek">
- <short>Extracts the day of the week from a DateTime value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="DayOfTheWeek.Result">
- <short>Day of the week from <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DayOfTheWeek.AValue">
- <short>DateTime to extract the day of the week from.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="HourOfTheWeek">
- <short>Calculate the number of hours elapsed since the start of the week.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="HourOfTheWeek.Result">
- <short>Number of hours elapsed since the start of the week till <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="HourOfTheWeek.AValue">
- <short>DateTime value for which to calculate the hour of the week.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MinuteOfTheWeek">
- <short>Calculate the number of seconds elapsed since the start of the week</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MinuteOfTheWeek.Result">
- <short>Number of seconds elapsed since the start of the week</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MinuteOfTheWeek.AValue">
- <short>Moment in the week.</short>
- </element>
- <element name="SecondOfTheWeek">
- <short>Calculate the number of seconds elapsed since the start of the week</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SecondOfTheWeek.Result">
- <short>Number of seconds elapsed since the start of the week</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondOfTheWeek.AValue">
- <short>Moment in the week</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MilliSecondOfTheWeek">
- <short>Calculate the number of milliseconds elapsed since the start of the week</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MilliSecondOfTheWeek.Result">
- <short></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondOfTheWeek.AValue">
- <short></short>
- </element>
- <!-- function Visibility: default -->
- <element name="HourOfTheDay">
- <short>Calculate the hour of a given DateTime value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="HourOfTheDay.Result">
- <short>Hour part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="HourOfTheDay.AValue">
- <short>DateTime to calculate the hour of.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MinuteOfTheDay">
- <short>Calculate the number of minutes elapsed since the start of the day</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MinuteOfTheDay.Result">
- <short>Number of minutes elapsed since the start of the day</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MinuteOfTheDay.AValue">
- <short>Moment in the day</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SecondOfTheDay">
- <short>Calculate the number of seconds elapsed since the start of the day</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SecondOfTheDay.Result">
- <short>Number of seconds elapsed since the start of the day</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondOfTheDay.AValue">
- <short>Moment in the day</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MilliSecondOfTheDay">
- <short>Calculate the number of milliseconds elapsed since the start of the day</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MilliSecondOfTheDay.Result">
- <short>Number of milliseconds elapsed since the start of the day</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondOfTheDay.AValue">
- <short>Moment in the day</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MinuteOfTheHour">
- <short>Calculate the number of minutes elapsed since the start of the hour</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MinuteOfTheHour.Result">
- <short>Number of minutes elapsed since the start of the hour</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MinuteOfTheHour.AValue">
- <short>Moment in the hour</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SecondOfTheHour">
- <short>Calculate the number of seconds elapsed since the start of the hour</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SecondOfTheHour.Result">
- <short>Number of seconds elapsed since the start of the hour</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondOfTheHour.AValue">
- <short>Moment in the hour</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MilliSecondOfTheHour">
- <short>Calculate the number of milliseconds elapsed since the start of the hour</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MilliSecondOfTheHour.Result">
- <short>Number of milliseconds elapsed since the start of the hour</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondOfTheHour.AValue">
- <short>Moment in the hour</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SecondOfTheMinute">
- <short>Calculate the number of seconds elapsed since the start of the minute</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SecondOfTheMinute.Result">
- <short>Number of seconds elapsed since the start of the minute</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondOfTheMinute.AValue">
- <short>Moment in the minute</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MilliSecondOfTheMinute">
- <short>Calculate the number of milliseconds elapsed since the start of the minute</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MilliSecondOfTheMinute.Result">
- <short>Number of milliseconds elapsed since the start of the minute</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondOfTheMinute.AValue">
- <short>Moment in the minute</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MilliSecondOfTheSecond">
- <short>Calculate the number of milliseconds elapsed since the start of the second</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MilliSecondOfTheSecond.Result">
- <short>Number of milliseconds elapsed since the start of the second</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondOfTheSecond.AValue">
- <short>Moment in the second</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WithinPastYears">
- <short>Check whether two datetimes are only a number of years apart</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WithinPastYears.Result">
- <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AYears</var> apart,
- <var>false</var> otherwise</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastYears.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastYears.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastYears.AYears">
- <short>Number of years to check</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WithinPastMonths">
- <short>Check whether two datetimes are only a number of months apart</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WithinPastMonths.Result">
- <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AMonths</var> apart,
- <var>false</var> otherwise</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastMonths.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastMonths.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastMonths.AMonths">
- <short>Number of months to check</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WithinPastWeeks">
- <short>Check whether two datetimes are only a number of weeks apart</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WithinPastWeeks.Result">
- <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AWeeks</var> apart,
- <var>false</var> otherwise</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastWeeks.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastWeeks.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastWeeks.AWeeks">
- <short>Number of weeks to check</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WithinPastDays">
- <short>Check whether two datetimes are only a number of days apart</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WithinPastDays.Result">
- <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>ADays</var> apart,
- <var>false</var> otherwise</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastDays.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastDays.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastDays.ADays">
- <short>Number of days to check</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WithinPastHours">
- <short>Check whether two datetimes are only a number of hours apart</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WithinPastHours.Result">
- <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AHours</var> apart,
- <var>false</var> otherwise</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastHours.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastHours.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastHours.AHours">
- <short>Number of hours to check</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WithinPastMinutes">
- <short>Check whether two datetimes are only a number of minutes apart</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WithinPastMinutes.Result">
- <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AMinutes</var> apart,
- <var>false</var> otherwise</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastMinutes.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastMinutes.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastMinutes.AMinutes">
- <short>Number of minutes to check</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WithinPastSeconds">
- <short>Check whether two datetimes are only a number of seconds apart</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WithinPastSeconds.Result">
- <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>ASeconds</var> apart,
- <var>false</var> otherwise</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastSeconds.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastSeconds.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastSeconds.ASeconds">
- <short>Number of seconds to check</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WithinPastMilliSeconds">
- <short>Check whether two datetimes are only a number of milliseconds apart</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WithinPastMilliSeconds.Result">
- <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AMilliSeconds</var> apart,
- <var>false</var> otherwise</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastMilliSeconds.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastMilliSeconds.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WithinPastMilliSeconds.AMilliSeconds">
- <short>Number of milliseconds to check</short>
- </element>
- <!-- function Visibility: default -->
- <element name="YearsBetween">
- <short>Calculate the number of whole years between two DateTime values</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="YearsBetween.Result">
- <short>Number of whole years between <var>ANow</var> and <var>AThen</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="YearsBetween.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="YearsBetween.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MonthsBetween">
- <short>Calculate the number of whole months between two DateTime values</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MonthsBetween.Result">
- <short>Number of whole months between <var>ANow</var> and <var>AThen</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MonthsBetween.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MonthsBetween.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WeeksBetween">
- <short>Calculate the number of whole weeks between two DateTime values</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WeeksBetween.Result">
- <short>Number of whole weeks between <var>ANow</var> and <var>AThen</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeeksBetween.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeeksBetween.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DaysBetween">
- <short>Number of whole days between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="DaysBetween.Result">
- <short>Number of whole days between <var>ANow</var> and <var>AThen</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DaysBetween.ANow">
- <short>First date</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DaysBetween.AThen">
- <short>Second date</short>
- </element>
- <!-- function Visibility: default -->
- <element name="HoursBetween">
- <short>Calculate the number of whole hours between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="HoursBetween.Result">
- <short>Number of hours between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="HoursBetween.ANow">
- <short>First DateTime value</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="HoursBetween.AThen">
- <short>Second DateTime value</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MinutesBetween">
- <short>Calculate the number of whole minutes between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MinutesBetween.Result">
- <short>Number of minutes between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MinutesBetween.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MinutesBetween.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SecondsBetween">
- <short>Calculate the number of whole seconds between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SecondsBetween.Result">
- <short>Number of seconds between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondsBetween.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondsBetween.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MilliSecondsBetween">
- <short>Calculate the number of whole milliseconds between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MilliSecondsBetween.Result">
- <short>Number of milliseconds between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondsBetween.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondsBetween.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="YearSpan">
- <short>Calculate the approximate number of years between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="YearSpan.Result">
- <short>Number (fractions included) of years between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="YearSpan.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="YearSpan.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MonthSpan">
- <short>Calculate the approximate number of months between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MonthSpan.Result">
- <short>Number (fractions included) of months between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MonthSpan.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MonthSpan.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="WeekSpan">
- <short>Calculate the approximate number of weeks between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="WeekSpan.Result">
- <short>Number (fractions included) of weeks between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeekSpan.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="WeekSpan.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DaySpan">
- <short>Calculate the approximate number of days between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="DaySpan.Result">
- <short>Number (fractions included) of days between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DaySpan.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DaySpan.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="HourSpan">
- <short>Calculate the approximate number of hours between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="HourSpan.Result">
- <short>Number (fractions included) of hours between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="HourSpan.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="HourSpan.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MinuteSpan">
- <short>Calculate the approximate number of minutes between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="MinuteSpan.Result">
- <short>Number (fractions included) of minutes between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MinuteSpan.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MinuteSpan.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SecondSpan">
- <short>Calculate the approximate number of seconds between two DateTime values.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SecondSpan.Result">
- <short>Number (fractions included) of seconds between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondSpan.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SecondSpan.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="MilliSecondSpan">
- <short>alculate the approximate number of seconds between two DateTime values.</short>
- <descr>
- <p>
- Since millisecond are the smallest unit of a <var>TDateTime</var> value, the number
- will always be an integer value, even though a double is returned.
- </p>
- </descr>
- </element>
- <!-- function result Visibility: default -->
- <element name="MilliSecondSpan.Result">
- <short>Number (fractions included) of seconds between <var>ANow</var> and <var>AThen</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondSpan.ANow">
- <short>First moment in time</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="MilliSecondSpan.AThen">
- <short>Second moment in time</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IncYear">
- <short>Increase a DateTime value with a number of years.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="IncYear.Result">
- <short>DateTime representing <var>AValue</var> plus <var>ANumberOfYears</var> years.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncYear.AValue">
- <short>DateTime to which years should be added.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncWeek.ANumberOfWeeks">
- <short>Number of weeks to add</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IncWeek">
- <short>Increase a DateTime value with a number of weeks.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="IncWeek.Result">
- <short>DateTime representing <var>AValue</var> plus <var>ANumberOfWeeks</var> weeks.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncWeek.AValue">
- <short>DateTime to which weeks should be added.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncDay.ANumberOfDays">
- <short>Number of days to add.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IncDay">
- <short>Increase a DateTime value with a number of days.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="IncDay.Result">
- <short>DateTime representing <var>AValue</var> plus <var>ANumberOfDays</var> days.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncDay.AValue">
- <short>DateTime value to which days should be added.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncHour.ANumberOfHours">
- <short>Number of hours to add</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IncHour">
- <short>Increase a DateTime value with a number of hours.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="IncHour.Result">
- <short>DateTime representing <var>AValue</var> plus <var>ANumberOfHours</var> hours.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncHour.AValue">
- <short>DateTime to which hours should be added.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncMinute.ANumberOfMinutes">
- <short>Number of minutes to add</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IncMinute">
- <short>Increase a DateTime value with a number of minutes.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="IncMinute.Result">
- <short>DateTime representing <var>AValue</var> plus <var>ANumberOfMinutes</var> minutes.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncMinute.AValue">
- <short>DateTime to which minutes should be added.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncSecond.ANumberOfSeconds">
- <short>Number of seconds to add</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IncSecond">
- <short>Increase a DateTime value with a number of seconds.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="IncSecond.Result">
- <short>DateTime representing <var>AValue</var> plus <var>ANumberOfSeconds</var> seconds.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncSecond.AValue">
- <short>DateTime to which seconds should be added.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncMilliSecond.ANumberOfMilliSeconds">
- <short>Number of milliseconds to add</short>
- </element>
- <!-- function Visibility: default -->
- <element name="IncMilliSecond">
- <short>Increase a DateTime value with a number of milliseconds.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="IncMilliSecond.Result">
- <short>DateTime representing <var>AValue</var> plus <var>ANumberOfMilliSeconds</var> milliseconds.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="IncMilliSecond.AValue">
- <short>DateTime to which milliseconds should be added.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EncodeDateTime">
- <short>Encodes a DateTime value from all its parts</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EncodeDateTime.Result">
- <short>DateTime value representing the complete timestamp</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateTime.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateTime.AMonth">
- <short>Month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateTime.ADay">
- <short>Day of the month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateTime.AHour">
- <short>Hour of the day</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateTime.AMinute">
- <short>Minutes</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateTime.ASecond">
- <short>Seconds</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateTime.AMilliSecond">
- <short>Milliseconds</short>
- </element>
- <!-- procedure Visibility: default -->
- <element name="DecodeDateTime">
- <short>Decode a datetime value in a date and time value</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateTime.AValue">
- <short>DateTime to decode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateTime.AYear">
- <short>Returns the year part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateTime.AMonth">
- <short>Returns the month part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateTime.ADay">
- <short>Returns the day part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateTime.AHour">
- <short>Returns the hour part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateTime.AMinute">
- <short>Returns the minute part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateTime.ASecond">
- <short>Returns the second part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateTime.AMilliSecond">
- <short>Returns the millisecond part of <var>AValue</var>.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="TryEncodeDateTime">
- <short>Encode a Year, Month, Day, Hour, minute, seconds, milliseconds tuplet to a <var>TDateTime</var> value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="TryEncodeDateTime.Result">
- <short><var>True</var> if the encoding was succesful</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateTime.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateTime.AMonth">
- <short>Month in year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateTime.ADay">
- <short>Day in month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateTime.AHour">
- <short>Hour of the day</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateTime.AMinute">
- <short>Minutes in the hour</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateTime.ASecond">
- <short>Seconds in the minute</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateTime.AMilliSecond">
- <short>Millisecond in the second</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateTime.AValue">
- <short>Encoded <var>TDateTime</var> value.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EncodeDateWeek">
- <short>Encode a <var>TDateTime</var> value from a year, week and day of week triplet</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EncodeDateWeek.Result">
- <short>DateTime value representing <var>AYear</var>, <var>AWeekOfYear</var> and <var>ADayOfWeek</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateWeek.AYear">
- <short>Year part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateWeek.AWeekOfYear">
- <short>Week of the year part</short>
- </element>
- <!-- procedure Visibility: default -->
- <element name="DecodeDateWeek">
- <short>Decode a DateTime value in a week of year and day of week.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateWeek.AValue">
- <short>DateTime to decode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateWeek.AYear">
- <short>Returns the year part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateWeek.AWeekOfYear">
- <short>Returns the week of year part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateWeek.ADayOfWeek">
- <short>Returns the day of week part of <var>AValue</var>.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="TryEncodeDateWeek">
- <short>Encode a year, week and day of week triplet to a <var>TDateTime</var> value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="TryEncodeDateWeek.Result">
- <short><var>True</var> if the encoding was succeful, <var>False</var> otherwise.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateWeek.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateWeek.AWeekOfYear">
- <short>Week in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateWeek.AValue">
- <short>Encoded <var>TDateTime</var> value</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateWeek.ADayOfWeek">
- <short>Day of the week (default 1).</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EncodeDateDay">
- <short>Encodes a year and day of year to a DateTime value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EncodeDateDay.Result">
- <short>DateTime value representing the date specified by <var>AYear</var> and <var>ADayOfYear</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateDay.AYear">
- <short>Year part.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateDay.ADayOfYear">
- <short>Day of the year part</short>
- </element>
- <!-- procedure Visibility: default -->
- <element name="DecodeDateDay">
- <short>Decode a DateTime value in year and year of day.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateDay.AValue">
- <short>DateTime to decode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateDay.AYear">
- <short>Returns the year part of <var>AValue</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateDay.ADayOfYear">
- <short>Returns the day-of-year part of <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="TryEncodeDateDay">
- <short>Encode a year and day of year to a <var>TDateTime</var> value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="TryEncodeDateDay.Result">
- <short><var>True</var> if the encoding was succesful, <var>False</var> if not.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateDay.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateDay.ADayOfYear">
- <short>Day in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateDay.AValue">
- <short>Encoded <var>TDateTime</var> value.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EncodeDateMonthWeek">
- <short>Encodes a year, month, week of month and day of week to a DateTime value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EncodeDateMonthWeek.Result">
- <short>DateTime value representing the date specified by <var>AYear</var>, <var>AMonth</var>, <var>AWeekOfMonth</var> and <var>ADayOfWeek</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateMonthWeek.AYear">
- <short>Year part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateMonthWeek.AMonth">
- <short>Month part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateMonthWeek.AWeekOfMonth">
- <short>Week of the month part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDateMonthWeek.ADayOfWeek">
- <short>Day of the week part</short>
- </element>
- <!-- procedure Visibility: default -->
- <element name="DecodeDateMonthWeek">
- <short>Decode a DateTime value in a month, week of month and day of week</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateMonthWeek.AValue">
- <short>DateTime to decode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateMonthWeek.AYear">
- <short>Returns the year part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateMonthWeek.AMonth">
- <short>Returns the month part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateMonthWeek.AWeekOfMonth">
- <short>Returns the week of month part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDateMonthWeek.ADayOfWeek">
- <short>Returns the day of week part of <var>AValue</var>.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="TryEncodeDateMonthWeek">
- <short>Encode a year, month, week of month and day of week to a <var>TDateTime</var> value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="TryEncodeDateMonthWeek.Result">
- <short><var>True</var> if the encoding was succesful, <var>False</var> if not.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateMonthWeek.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateMonthWeek.AMonth">
- <short>Month in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateMonthWeek.AWeekOfMonth">
- <short>Week in the month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateMonthWeek.ADayOfWeek">
- <short>Day in the week</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDateMonthWeek.AValue">
- <short>Encoded <var>TDateTime</var> value</short>
- </element>
- <!-- function Visibility: default -->
- <element name="RecodeYear">
- <short>Replace year part of a <var>TDateTime</var> value with another year.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="RecodeYear.Result">
- <short><var>AValue</var> with replaced year.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeYear.AValue">
- <short>Date to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeYear.AYear">
- <short>Year to replace in <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="RecodeMonth">
- <short>Replace month part of a <var>TDateTime</var> value with another month.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="RecodeMonth.Result">
- <short><var>AValue</var> with replaced month.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeMonth.AValue">
- <short>Date to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeMonth.AMonth">
- <short>Month to replace in <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="RecodeDay">
- <short>Replace day part of a <var>TDateTime</var> value with another day.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="RecodeDay.Result">
- <short><var>AValue</var> with replaced day.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDay.AValue">
- <short>Date to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDay.ADay">
- <short>Day to replace in <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="RecodeHour">
- <short>Replace hours part of a <var>TDateTime</var> value with another hour.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="RecodeHour.Result">
- <short><var>AValue</var> with replaced hour.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeHour.AValue">
- <short>Date/time to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeHour.AHour">
- <short>Hour to replace in <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="RecodeMinute">
- <short>Replace minutse part of a <var>TDateTime</var> value with another minute.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="RecodeMinute.Result">
- <short><var>AValue</var> with replaced minute.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeMinute.AValue">
- <short>Date/time to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeMinute.AMinute">
- <short>Minute to replace in <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="RecodeSecond">
- <short>Replace seconds part of a <var>TDateTime</var> value with another second.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="RecodeSecond.Result">
- <short><var>AValue</var> with replaced second.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeSecond.AValue">
- <short>Date/time to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeSecond.ASecond">
- <short>Second to replace in <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="RecodeMilliSecond">
- <short>Replace milliseconds part of a <var>TDateTime</var> value with another millisecond.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="RecodeMilliSecond.Result">
- <short><var>AValue</var> with replaced millisecond.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeMilliSecond.AValue">
- <short>Date/time to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeMilliSecond.AMilliSecond">
- <short>Millisecond to replace in <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="RecodeDate">
- <short>Replace date part of a <var>TDateTime</var> value with another date.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="RecodeDate.Result">
- <short><var>AValue</var> with replaced date.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDate.AValue">
- <short>Date/time to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDate.AYear">
- <short>Year to replace in <var>AValue</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDate.AMonth">
- <short>Month to replace in <var>AValue</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDate.ADay">
- <short>Day to replace in <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="RecodeTime">
- <short>Replace time part of a <var>TDateTime</var> value with another time.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="RecodeTime.Result">
- <short><var>AValue</var> with replaced time.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeTime.AValue">
- <short>Date/time to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeTime.AHour">
- <short>Hour to replace in <var>AValue</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeTime.AMinute">
- <short>Minute to replace in <var>AValue</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeTime.ASecond">
- <short>Second to replace in <var>AValue</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeTime.AMilliSecond">
- <short>Millisecond to replace in <var>AValue</var></short>
- </element>
- <!-- function Visibility: default -->
- <element name="RecodeDateTime">
- <short>Replace selected parts of a <var>TDateTime</var> value with other values </short>
- </element>
- <!-- function result Visibility: default -->
- <element name="RecodeDateTime.Result">
- <short><var>AValue</var> with replaced parts</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDateTime.AValue">
- <short>Date/time to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDateTime.AYear">
- <short>New value for year part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDateTime.AMonth">
- <short>New value for month part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDateTime.ADay">
- <short>New value for day part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDateTime.AHour">
- <short>New value for hour part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDateTime.AMinute">
- <short>New value for minute part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDateTime.ASecond">
- <short>New value for second part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="RecodeDateTime.AMilliSecond">
- <short>New value for millisecond part</short>
- </element>
- <!-- function Visibility: default -->
- <element name="TryRecodeDateTime">
- <short>Replace selected parts of a <var>TDateTime</var> value with other values</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="TryRecodeDateTime.Result">
- <short><var>True</var> if the recoding was succesful, <var>False</var> if not.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryRecodeDateTime.AValue">
- <short>Date/time to recode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryRecodeDateTime.AYear">
- <short>New value for year part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryRecodeDateTime.AMonth">
- <short>New value for month part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryRecodeDateTime.ADay">
- <short>New value for day part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryRecodeDateTime.AHour">
- <short>New value for hour part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryRecodeDateTime.AMinute">
- <short>New value for minute part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryRecodeDateTime.ASecond">
- <short>New value for second part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryRecodeDateTime.AMilliSecond">
- <short>New value for millisecond part</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryRecodeDateTime.AResult">
- <short>Recoded <var>AValue</var>.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="CompareDateTime">
- <short>Compare 2 dates, taking into account the time of day</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="CompareDateTime.Result">
- <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>
- </element>
- <!-- argument Visibility: default -->
- <element name="CompareDateTime.A">
- <short>First date-time to compare</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="CompareDateTime.B">
- <short>First date-time to compare</short>
- </element>
- <!-- function Visibility: default -->
- <element name="CompareDate">
- <short>Compare 2 dates, disregarding the time of day</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="CompareDate.Result">
- <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>
- </element>
- <!-- argument Visibility: default -->
- <element name="CompareDate.A">
- <short>First date to compare</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="CompareDate.B">
- <short>Second date to compare</short>
- </element>
- <!-- function Visibility: default -->
- <element name="CompareTime">
- <short>Compares two times of the day, disregarding the date part.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="CompareTime.Result">
- <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>
- </element>
- <!-- argument Visibility: default -->
- <element name="CompareTime.A">
- <short>First time to compare</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="CompareTime.B">
- <short>Second time to compare</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SameDateTime">
- <short>Check whether two <var>TDateTime</var> values have the same date and time parts.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SameDateTime.Result">
- <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>
- </element>
- <!-- argument Visibility: default -->
- <element name="SameDateTime.A">
- <short>First DateTime value</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SameDateTime.B">
- <short>Second DateTime value</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SameDate">
- <short>Check whether two <var>TDateTime</var> values have the same date part.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SameDate.Result">
- <short><var>True</var> if <var>A</var> and <var>B</var> have the same time part, <var>False</var> if not</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SameDate.A">
- <short>First DateTime value</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SameDate.B">
- <short>Second DateTime value</short>
- </element>
- <!-- function Visibility: default -->
- <element name="SameTime">
- <short>Check whether two <var>TDateTime</var> values have the same time part.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="SameTime.Result">
- <short><var>True</var> if <var>A</var> and <var>B</var> have the same time part, <var>False</var> if not.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SameTime.A">
- <short>First DateTime value</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="SameTime.B">
- <short>Second DateTime value</short>
- </element>
- <!-- function Visibility: default -->
- <element name="NthDayOfWeek">
- <short>Calculate which occurrence of weekday in the month a given day represents</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="NthDayOfWeek.Result">
- <short>Occurrence of weekday in the month of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="NthDayOfWeek.AValue">
- <short>Date to check.</short>
- </element>
- <!-- procedure Visibility: default -->
- <element name="DecodeDayOfWeekInMonth">
- <short>Decode a DateTime value in year, month, day of week parts</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDayOfWeekInMonth.AValue">
- <short>DateTime to decode</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDayOfWeekInMonth.AYear">
- <short>Returns the year part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDayOfWeekInMonth.AMonth">
- <short>Returns the month part of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDayOfWeekInMonth.ANthDayOfWeek">
- <short>Returns which <var>ADayofWeek</var> of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DecodeDayOfWeekInMonth.ADayOfWeek">
- <short>Returns the day of week part of <var>AValue</var>.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="EncodeDayOfWeekInMonth">
- <short>Encodes a year, month, week, day of week specification to a <var>TDateTime</var> value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="EncodeDayOfWeekInMonth.Result">
- <short><var>TDateTime</var> value representing <var>AYear</var> , <var>AMonth</var><var>ANthDayOfWeek</var> .and <var>ADayOfWeek</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDayOfWeekInMonth.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDayOfWeekInMonth.AMonth">
- <short>Month in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDayOfWeekInMonth.ANthDayOfWeek">
- <short>Week in the month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="EncodeDayOfWeekInMonth.ADayOfWeek">
- <short>Day of the week</short>
- </element>
- <!-- function Visibility: default -->
- <element name="TryEncodeDayOfWeekInMonth">
- <short>Encode a year, month, week, day of week triplet to a <var>TDateTime</var> value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="TryEncodeDayOfWeekInMonth.Result">
- <short><var>True</var> if the encoding was succesful, <var>False</var> if not.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDayOfWeekInMonth.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDayOfWeekInMonth.AMonth">
- <short>Month in year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDayOfWeekInMonth.ANthDayOfWeek">
- <short>Day of week occurrence</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDayOfWeekInMonth.ADayOfWeek">
- <short>Day of week</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryEncodeDayOfWeekInMonth.AValue">
- <short>Resulting TDateTime value</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateTimeError.ABaseDate">
- <short>Base date time to use when creating the string representing the date/time. Default 0</short>
- </element>
- <!-- procedure Visibility: default -->
- <element name="InvalidDateTimeError">
- <short>Raise an <var>EConvertError</var> about an invalid date-time specification.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateTimeError.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateTimeError.AMonth">
- <short>Month in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateTimeError.ADay">
- <short>Day of the month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateTimeError.AHour">
- <short>Hour of the day</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateTimeError.AMinute">
- <short>Minute of the hour</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateTimeError.ASecond">
- <short>Seconds in the minute</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateTimeError.AMilliSecond">
- <short>Milliseconds in second</short>
- </element>
- <!-- procedure Visibility: default -->
- <element name="InvalidDateWeekError">
- <short>Raise an EConvertError with an invalid Year, WeekOfyear and DayOfWeek specification</short>
- </element>
- <!-- procedure Visibility: default -->
- <element name="InvalidDateDayError">
- <short>Raise an <var>EConvertError</var> exception when a day is not a valid day of a year.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateDayError.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateDayError.ADayOfYear">
- <short>Invalid day of the year.</short>
- </element>
- <!-- procedure Visibility: default -->
- <element name="InvalidDateMonthWeekError">
- <short>Raise an <var>EConvertError</var> exception when a Year,Month,WeekOfMonth,DayofWeek is invalid.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateMonthWeekError.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateMonthWeekError.AMonth">
- <short>Month of the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateMonthWeekError.AWeekOfMonth">
- <short>Week of the month</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDateMonthWeekError.ADayOfWeek">
- <short>Day of the week</short>
- </element>
- <!-- procedure Visibility: default -->
- <element name="InvalidDayOfWeekInMonthError">
- <short>Raise an <var>EConvertError</var> exception when a Year,Month,NthDayofWeek,DayofWeek is invalid.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDayOfWeekInMonthError.AYear">
- <short>Year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDayOfWeekInMonthError.AMonth">
- <short>Month in the year</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDayOfWeekInMonthError.ANthDayOfWeek">
- <short>Nth occurrence of day of week.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="InvalidDayOfWeekInMonthError.ADayOfWeek">
- <short>Day of week.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DateTimeToJulianDate">
- <short>Converts a TDateTime value to a Julian date representation</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="DateTimeToJulianDate.Result">
- <short>Julian representation of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DateTimeToJulianDate.AValue">
- <short>DateTime value to convert to Julian representation</short>
- </element>
- <!-- function Visibility: default -->
- <element name="JulianDateToDateTime">
- <short>Convert a Julian date representation to a <var>TDateTime</var> value.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="JulianDateToDateTime.Result">
- <short>Resulting <var>TDateTime</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="JulianDateToDateTime.AValue">
- <short>Date in Julian notation</short>
- </element>
- <!-- function Visibility: default -->
- <element name="TryJulianDateToDateTime">
- <short>Convert a Julian date representation to a <var>TDateTime</var> value.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="TryJulianDateToDateTime.Result">
- <short><var>True</var> if the conversion was succesful, <var>False</var> if not.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryJulianDateToDateTime.AValue">
- <short>Date in Julian notation</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryJulianDateToDateTime.ADateTime">
- <short>Resulting <var>TDateTime</var> equivalent</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DateTimeToModifiedJulianDate">
- <short>Convert a <var>TDateTime</var> value to a modified Julian date representation</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="DateTimeToModifiedJulianDate.Result">
- <short>Modified Julian representation of <var>AValue</var>.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DateTimeToModifiedJulianDate.AValue">
- <short>DateTime value to convert to Modified Julian representation</short>
- </element>
- <!-- function Visibility: default -->
- <element name="ModifiedJulianDateToDateTime">
- <short>Convert a modified Julian date representation to a <var>TDateTime</var> value.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="ModifiedJulianDateToDateTime.Result">
- <short><var>AValue</var> in modified Julian date notation.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="ModifiedJulianDateToDateTime.AValue">
- <short>Date to convert</short>
- </element>
- <!-- function Visibility: default -->
- <element name="TryModifiedJulianDateToDateTime">
- <short>Convert a modified Julian date representation to a <var>TDateTime</var> value.</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="TryModifiedJulianDateToDateTime.Result">
- <short><var>True</var> if the conversion was succesful, <var>False</var> if not.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryModifiedJulianDateToDateTime.AValue">
- <short>Modified Julian date to convert</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TryModifiedJulianDateToDateTime.ADateTime">
- <short><var>AValue</var> as a <var>TDateTime</var> value.</short>
- </element>
- <!-- function Visibility: default -->
- <element name="DateTimeToUnix">
- <short>Convert a <var>TDateTime</var> value to Unix epoch time</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="DateTimeToUnix.Result">
- <short>Unix epoch time corresponding to <var>AValue</var></short>
- </element>
- <!-- argument Visibility: default -->
- <element name="DateTimeToUnix.AValue">
- <short>DateTime value to convert</short>
- </element>
- <!-- function Visibility: default -->
- <element name="UnixToDateTime">
- <short>Convert Unix epoch time to a <var>TDateTime</var> value</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="UnixToDateTime.Result">
- <short><var>AValue</var> as a <var>TDateTime</var> value.</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="UnixToDateTime.AValue">
- <short>Date to convert.</short>
- </element>
- </module>
- <!-- dateutils -->
- </package>
- </fpdoc-descriptions>
|