dateutils.xml 170 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980
  1. <?xml version="1.0"?>
  2. <fpdoc-descriptions>
  3. <package name="rtl">
  4. <!--
  5. ====================================================================
  6. dateutils
  7. ====================================================================
  8. -->
  9. <module name="dateutils">
  10. <short>Date/Time manipulation routines.</short>
  11. <descr>
  12. <file>DateUtils</file> contains a large number of date/time manipulation
  13. routines, all based on the <var>TDateTime</var> type. There are routines for
  14. date/time math, for comparing dates and times, for composing dates and
  15. decomposing dates in their constituent parts.
  16. </descr>
  17. <!-- unresolved type reference Visibility: default -->
  18. <element name="SysUtils">
  19. <short>Exception support</short>
  20. </element>
  21. <!-- unresolved type reference Visibility: default -->
  22. <element name="Math">
  23. <short>Math support</short>
  24. </element>
  25. <!-- unresolved type reference Visibility: default -->
  26. <element name="Types">
  27. <short>Basic types</short>
  28. </element>
  29. <!-- constant Visibility: default -->
  30. <element name="DaysPerWeek">
  31. <short>Number of days in a week.</short>
  32. </element>
  33. <!-- constant Visibility: default -->
  34. <element name="WeeksPerFortnight">
  35. <short>Number of weeks in fortnight</short>
  36. </element>
  37. <!-- constant Visibility: default -->
  38. <element name="MonthsPerYear">
  39. <short>Number of months in a year</short>
  40. </element>
  41. <!-- constant Visibility: default -->
  42. <element name="YearsPerDecade">
  43. <short>Number of years in a decade</short>
  44. </element>
  45. <!-- constant Visibility: default -->
  46. <element name="YearsPerCentury">
  47. <short>Number of years in a century</short>
  48. </element>
  49. <!-- constant Visibility: default -->
  50. <element name="YearsPerMillennium">
  51. <short>Number of years in a millenium</short>
  52. </element>
  53. <!-- constant Visibility: default -->
  54. <element name="DayMonday">
  55. <short>ISO day number for Monday</short>
  56. </element>
  57. <!-- constant Visibility: default -->
  58. <element name="DayTuesday">
  59. <short>ISO day number for Tuesday</short>
  60. </element>
  61. <!-- constant Visibility: default -->
  62. <element name="DayWednesday">
  63. <short>ISO day number for Wednesday</short>
  64. </element>
  65. <!-- constant Visibility: default -->
  66. <element name="DayThursday">
  67. <short>ISO day number for Thursday</short>
  68. </element>
  69. <!-- constant Visibility: default -->
  70. <element name="DayFriday">
  71. <short>ISO day number for Friday</short>
  72. </element>
  73. <!-- constant Visibility: default -->
  74. <element name="DaySaturday">
  75. <short>ISO day number for Saturday</short>
  76. </element>
  77. <!-- constant Visibility: default -->
  78. <element name="DaySunday">
  79. <short>ISO day number for Sunday</short>
  80. </element>
  81. <!-- constant Visibility: default -->
  82. <element name="OneHour">
  83. <short>One hour as a fraction of a day (suitable for TDateTime)</short>
  84. </element>
  85. <!-- constant Visibility: default -->
  86. <element name="OneMinute">
  87. <short>One minute as a fraction of a day (suitable for TDateTime)</short>
  88. </element>
  89. <!-- constant Visibility: default -->
  90. <element name="OneSecond">
  91. <short>One second as a fraction of a day (suitable for TDateTime)</short>
  92. </element>
  93. <!-- constant Visibility: default -->
  94. <element name="OneMillisecond">
  95. <short>One millisecond as a fraction of a day (suitable for TDateTime)</short>
  96. </element>
  97. <!-- constant Visibility: default -->
  98. <element name="DaysPerYear">
  99. <short>Array with number of days in a year. The boolean index indicates whether it is a leap year or not.</short>
  100. </element>
  101. <!-- constant Visibility: default -->
  102. <element name="RecodeLeaveFieldAsIs">
  103. <short>Bitmask deciding what to do with each TDateTime field in recode routines</short>
  104. </element>
  105. <!-- constant Visibility: default -->
  106. <element name="ApproxDaysPerMonth">
  107. <short>Average number of days in a month, measured over a year. Used in <link id="MonthsBetween"/>.</short>
  108. </element>
  109. <!-- constant Visibility: default -->
  110. <element name="ApproxDaysPerYear">
  111. <short>Average number of days in a year, measured over 4 years. Used in <link id="YearsBetween"/>.</short>
  112. </element>
  113. <!-- function Visibility: default -->
  114. <element name="DateOf">
  115. <short>Extract the date part from a DateTime indication.</short>
  116. <descr>
  117. <p>
  118. <var>DateOf</var> extracts the date part from <var>AValue</var> and returns
  119. the result.
  120. </p>
  121. <p>
  122. Since the <var>TDateTime</var> is actually a double with the date part
  123. encoded in the integer part, this operation corresponds to a call to
  124. <var>Trunc</var>.
  125. </p>
  126. </descr>
  127. <seealso>
  128. <link id="TimeOf"/>
  129. <link id="YearOf"/>
  130. <link id="MonthOf"/>
  131. <link id="DayOf"/>
  132. <link id="HourOf"/>
  133. <link id="MinuteOf"/>
  134. <link id="SecondOf"/>
  135. <link id="MilliSecondOf"/>
  136. </seealso>
  137. <example file="datutex/ex1"/>
  138. </element>
  139. <!-- function result Visibility: default -->
  140. <element name="DateOf.Result">
  141. <short>Date part of <var>AValue</var>.</short>
  142. </element>
  143. <!-- argument Visibility: default -->
  144. <element name="DateOf.AValue">
  145. <short>Datetime to extract date from</short>
  146. </element>
  147. <!-- function Visibility: default -->
  148. <element name="TimeOf">
  149. <short>Extract the time part from a DateTime indication.</short>
  150. <descr>
  151. <p>
  152. <var>TimeOf</var> extracts the time part from <var>AValue</var> and returns
  153. the result.
  154. </p>
  155. <p>
  156. Since the <var>TDateTime</var> is actually a double with the time part
  157. encoded in the fractional part, this operation corresponds to a call to
  158. <var>Frac</var>.
  159. </p>
  160. </descr>
  161. <seealso>
  162. <link id="DateOf"/>
  163. <link id="YearOf"/>
  164. <link id="MonthOf"/>
  165. <link id="DayOf"/>
  166. <link id="HourOf"/>
  167. <link id="MinuteOf"/>
  168. <link id="SecondOf"/>
  169. <link id="MilliSecondOf"/>
  170. </seealso>
  171. <example file="datutex/ex2"/>
  172. </element>
  173. <!-- function result Visibility: default -->
  174. <element name="TimeOf.Result">
  175. <short>Time part of <var>AValue</var>.</short>
  176. </element>
  177. <!-- argument Visibility: default -->
  178. <element name="TimeOf.AValue">
  179. <short>Datetime to extract time from</short>
  180. </element>
  181. <!-- function Visibility: default -->
  182. <element name="IsInLeapYear">
  183. <short>Determine whether a date is in a leap year.</short>
  184. <descr>
  185. <var>IsInLeapYear</var> returns <var>True</var> if the year part of <var>AValue</var>
  186. is leap year, or <var>False</var> if not.
  187. </descr>
  188. <seealso>
  189. <link id="YearOf"/>
  190. <link id="IsPM"/>
  191. <link id="IsToday"/>
  192. <link id="IsSameDay"/>
  193. </seealso>
  194. <example file="datutex/ex3"/>
  195. </element>
  196. <!-- function result Visibility: default -->
  197. <element name="IsInLeapYear.Result">
  198. <short><var>True</var> if <var>AValue</var> is in a leap year, <var>False</var> if not.</short>
  199. </element>
  200. <!-- argument Visibility: default -->
  201. <element name="IsInLeapYear.AValue">
  202. <short>Date to be checked.</short>
  203. </element>
  204. <!-- function Visibility: default -->
  205. <element name="IsPM">
  206. <short>Determine whether a time is PM or AM.</short>
  207. <descr>
  208. <var>IsPM</var> returns <var>True</var> if the time part of
  209. <var>AValue</var> is later then 12:00 (PM, or afternoon).
  210. </descr>
  211. <seealso>
  212. <link id="YearOf"/>
  213. <link id="IsInLeapYear"/>
  214. <link id="IsToday"/>
  215. <link id="IsSameDay"/>
  216. </seealso>
  217. <example file="datutex/ex4"/>
  218. </element>
  219. <!-- function result Visibility: default -->
  220. <element name="IsPM.Result">
  221. <short><var>True</var> if the time part of <var>AValue</var> is PM (afternoon).</short>
  222. </element>
  223. <!-- argument Visibility: default -->
  224. <element name="IsPM.AValue">
  225. <short>Time to check.</short>
  226. </element>
  227. <!-- function Visibility: default -->
  228. <element name="IsValidDate">
  229. <short>Check whether a set of values is a valid date indication.</short>
  230. <descr>
  231. <p>
  232. <var>IsValidDate</var> returns <var>True</var> when the values <var>AYear</var>,
  233. <var>AMonth</var>, <var>ADay</var> form a valid date indication. If one of
  234. the values is not valid (e.g. the day is invalid or does not exist in that
  235. particular month), <var>False</var> is returned.
  236. </p>
  237. <p>
  238. <var>AYear</var> must be in the range 1..9999 to be valid.
  239. </p>
  240. </descr>
  241. <example file="datutex/ex5"/>
  242. <seealso>
  243. <link id="IsValidTime"/>
  244. <link id="IsValidDateTime"/>
  245. <link id="IsValidDateDay"/>
  246. <link id="IsValidDateWeek"/>
  247. <link id="IsValidDateMonthWeek"/>
  248. </seealso>
  249. </element>
  250. <!-- function result Visibility: default -->
  251. <element name="IsValidDate.Result">
  252. <short><var>True</var> if the given values form a valid date, <var>False</var> if not. </short>
  253. </element>
  254. <!-- argument Visibility: default -->
  255. <element name="IsValidDate.AYear">
  256. <short>Year value</short>
  257. </element>
  258. <!-- argument Visibility: default -->
  259. <element name="IsValidDate.AMonth">
  260. <short>Month in the year</short>
  261. </element>
  262. <!-- argument Visibility: default -->
  263. <element name="IsValidDate.ADay">
  264. <short>Day in the month</short>
  265. </element>
  266. <!-- function Visibility: default -->
  267. <element name="IsValidTime">
  268. <short>Check whether a set of values is a valid time indication.</short>
  269. <descr/>
  270. </element>
  271. <!-- function result Visibility: default -->
  272. <element name="IsValidTime.Result">
  273. <short><var>True</var> if the given values form a valid time, <var>False</var> if not.</short>
  274. <descr>
  275. <var>IsValidTime</var> returns <var>True</var> when the values
  276. <var>AHour</var>,
  277. <var>AMinute</var>, <var>ASecond</var> and <var>AMilliSecond</var> form a valid
  278. time indication. If one of the values is not valid (e.g. the seconds are
  279. larger than 60), <var>False</var> is returned.
  280. </descr>
  281. <example file="datutex/ex6"/>
  282. <seealso>
  283. <link id="IsValidDate"/>
  284. <link id="IsValidDateTime"/>
  285. <link id="IsValidDateDay"/>
  286. <link id="IsValidDateWeek"/>
  287. <link id="IsValidDateMonthWeek"/>
  288. </seealso>
  289. </element>
  290. <!-- argument Visibility: default -->
  291. <element name="IsValidTime.AHour">
  292. <short>Hour of the day.</short>
  293. </element>
  294. <!-- argument Visibility: default -->
  295. <element name="IsValidTime.AMinute">
  296. <short>Minute in the hour</short>
  297. </element>
  298. <!-- argument Visibility: default -->
  299. <element name="IsValidTime.ASecond">
  300. <short>Second in the minute</short>
  301. </element>
  302. <!-- argument Visibility: default -->
  303. <element name="IsValidTime.AMilliSecond">
  304. <short>Milliseconds in the second</short>
  305. </element>
  306. <!-- function Visibility: default -->
  307. <element name="IsValidDateTime">
  308. <short>Check whether a set of values is a valid date and time indication.</short>
  309. <descr>
  310. <p>
  311. <var>IsValidTime</var> returns <var>True</var> when the values
  312. <var>AYear</var>, <var>AMonth</var>, <var>ADay</var>,
  313. <var>AHour</var>, <var>AMinute</var>, <var>ASecond</var>
  314. and <var>AMilliSecond</var> form a valid date and time indication.
  315. If one of the values is not valid (e.g. the seconds are larger than 60), <var>False</var> is returned.
  316. </p>
  317. <p>
  318. <var>AYear</var> must be in the range 1..9999 to be valid.
  319. </p>
  320. </descr>
  321. <example file="datutex/ex7"/>
  322. <seealso>
  323. <link id="IsValidDate"/>
  324. <link id="IsValidTime"/>
  325. <link id="IsValidDateDay"/>
  326. <link id="IsValidDateWeek"/>
  327. <link id="IsValidDateMonthWeek"/>
  328. </seealso>
  329. </element>
  330. <!-- function result Visibility: default -->
  331. <element name="IsValidDateTime.Result">
  332. <short><var>True</var> if the given values form a valid date/time pair, <var>False</var> if not.</short>
  333. </element>
  334. <!-- argument Visibility: default -->
  335. <element name="IsValidDateTime.AYear">
  336. <short>Year value</short>
  337. </element>
  338. <!-- argument Visibility: default -->
  339. <element name="IsValidDateTime.AMonth">
  340. <short>Month in the year</short>
  341. </element>
  342. <!-- argument Visibility: default -->
  343. <element name="IsValidDateTime.ADay">
  344. <short>Day in the month</short>
  345. </element>
  346. <!-- argument Visibility: default -->
  347. <element name="IsValidDateTime.AHour">
  348. <short>Hour of the day</short>
  349. </element>
  350. <!-- argument Visibility: default -->
  351. <element name="IsValidDateTime.AMinute">
  352. <short>Minute in the hour</short>
  353. </element>
  354. <!-- argument Visibility: default -->
  355. <element name="IsValidDateTime.ASecond">
  356. <short>Second in the minute</short>
  357. </element>
  358. <!-- argument Visibility: default -->
  359. <element name="IsValidDateTime.AMilliSecond">
  360. <short>Milliseconds in the second</short>
  361. </element>
  362. <!-- function Visibility: default -->
  363. <element name="IsValidDateDay">
  364. <short>Check whether a given year/day of year combination is a valid date.</short>
  365. <descr>
  366. <p>
  367. <var>IsValidDateDay</var> returns <var>True</var> if <var>AYear</var> and
  368. <var>ADayOfYear</var> form a valid date indication, or <var>False</var>
  369. otherwise.
  370. </p>
  371. <p>
  372. <var>AYear</var> must be in the range 1..9999 to be valid.
  373. </p>
  374. <p>
  375. The <var>ADayOfYear</var> value is checked to see whether it falls within the valid range of
  376. dates for <var>AYear</var>.
  377. </p>
  378. </descr>
  379. <example file="datutex/ex9"/>
  380. <seealso>
  381. <link id="IsValidDate"/>
  382. <link id="IsValidTime"/>
  383. <link id="IsValidDateTime"/>
  384. <link id="IsValidDateWeek"/>
  385. <link id="IsValidDateMonthWeek"/>
  386. </seealso>
  387. </element>
  388. <!-- function result Visibility: default -->
  389. <element name="IsValidDateDay.Result">
  390. <short><var>True</var> if the given combination is a valid date, <var>False</var> otherwise.</short>
  391. </element>
  392. <!-- argument Visibility: default -->
  393. <element name="IsValidDateDay.AYear">
  394. <short>Year</short>
  395. </element>
  396. <!-- argument Visibility: default -->
  397. <element name="IsValidDateDay.ADayOfYear">
  398. <short>Day in the year</short>
  399. </element>
  400. <!-- function Visibility: default -->
  401. <element name="IsValidDateWeek">
  402. <short>Check whether a given year/week/day of the week combination is a valid day.</short>
  403. <descr>
  404. <p>
  405. <var>IsValidDateWeek</var> returns <var>True</var> if <var>AYear</var>,
  406. <var>AWeekOfYear</var> and <var>ADayOfWeek</var> form a valid date indication,
  407. or <var>False</var> otherwise.
  408. </p>
  409. <p>
  410. <var>AYear</var> must be in the range 1..9999 to be valid.
  411. </p>
  412. <p>
  413. The <var>ADayOfWeek</var>,<var>ADayOfWeek</var> values are checked to see whether
  414. the combination falls within the valid range of weeks for <var>AYear</var>.
  415. </p>
  416. </descr>
  417. <example file="datutex/ex10"/>
  418. <seealso>
  419. <link id="IsValidDate"/>
  420. <link id="IsValidTime"/>
  421. <link id="IsValidDateTime"/>
  422. <link id="IsValidDateDay"/>
  423. <link id="IsValidDateMonthWeek"/>
  424. </seealso>
  425. </element>
  426. <!-- function result Visibility: default -->
  427. <element name="IsValidDateWeek.Result">
  428. <short><var>True</var> if the given combination is a valid date, <var>False</var> otherwise.</short>
  429. </element>
  430. <!-- argument Visibility: default -->
  431. <element name="IsValidDateWeek.AYear">
  432. <short>Year</short>
  433. </element>
  434. <!-- argument Visibility: default -->
  435. <element name="IsValidDateWeek.AWeekOfYear">
  436. <short>Week in the year</short>
  437. </element>
  438. <!-- argument Visibility: default -->
  439. <element name="IsValidDateWeek.ADayOfWeek">
  440. <short>Day in the week</short>
  441. </element>
  442. <!-- function Visibility: default -->
  443. <element name="IsValidDateMonthWeek">
  444. <short>Check whether a given year/month/week/day of the week combination is a valid day</short>
  445. <descr>
  446. <p>
  447. <var>IsValidDateMonthWeek</var> returns <var>True</var> if <var>AYear</var>,
  448. <var>AMonth</var> <var>AWeekOfMonth</var> and <var>ADayOfWeek</var> form a valid date indication,
  449. or <var>False</var> otherwise.
  450. </p>
  451. <p>
  452. <var>AYear</var> must be in the range 1..9999 to be valid.
  453. </p>
  454. <p>
  455. The <var>AWeekOfMonth</var>,<var>ADayOfWeek</var> values are checked to see whether
  456. the combination falls within the valid range of weeks for the
  457. <var>AYear</var>,<var>AMonth</var> combination.
  458. </p>
  459. </descr>
  460. <example file="datutex/ex11"/>
  461. <seealso>
  462. <link id="IsValidDate"/>
  463. <link id="IsValidTime"/>
  464. <link id="IsValidDateTime"/>
  465. <link id="IsValidDateDay"/>
  466. <link id="IsValidDateWeek"/>
  467. </seealso>
  468. </element>
  469. <!-- function result Visibility: default -->
  470. <element name="IsValidDateMonthWeek.Result">
  471. <short><var>True</var> if the given combination is a valid date, <var>False</var> otherwise.</short>
  472. </element>
  473. <!-- argument Visibility: default -->
  474. <element name="IsValidDateMonthWeek.AYear">
  475. <short>Year</short>
  476. </element>
  477. <!-- argument Visibility: default -->
  478. <element name="IsValidDateMonthWeek.AMonth">
  479. <short>Month of the year</short>
  480. </element>
  481. <!-- argument Visibility: default -->
  482. <element name="IsValidDateMonthWeek.AWeekOfMonth">
  483. <short>Week of the month.</short>
  484. </element>
  485. <!-- argument Visibility: default -->
  486. <element name="IsValidDateMonthWeek.ADayOfWeek">
  487. <short>Day in the week.</short>
  488. </element>
  489. <!-- function Visibility: default -->
  490. <element name="WeeksInYear">
  491. <short>return the number of weeks in the year, given a date</short>
  492. <descr>
  493. <p>
  494. <var>WeeksInYear</var> returns the number of weeks in the year part of
  495. <var>AValue</var>. The return value is either 52 or 53.
  496. </p>
  497. <remark>
  498. The first week of the year is determined according to the ISO 8601 standard:
  499. It is the first week that has at least 4 days in it, i.e. it includes a
  500. thursday.
  501. </remark>
  502. </descr>
  503. <seealso>
  504. <link id="WeeksInAYear"/>
  505. <link id="DaysInYear"/>
  506. <link id="DaysInAYear"/>
  507. <link id="DaysInMonth"/>
  508. <link id="DaysInAMonth"/>
  509. </seealso>
  510. <example file="datutex/ex12"/>
  511. </element>
  512. <!-- function result Visibility: default -->
  513. <element name="WeeksInYear.Result">
  514. <short>Number of weeks.</short>
  515. </element>
  516. <!-- argument Visibility: default -->
  517. <element name="WeeksInYear.AValue">
  518. <short>Day in the year.</short>
  519. </element>
  520. <!-- function Visibility: default -->
  521. <element name="WeeksInAYear">
  522. <short>Return the number of weeks in a given year</short>
  523. <descr>
  524. <p>
  525. <var>WeeksInAYear</var> returns the number of weeks in the year
  526. <var>AYear</var>. The return value is either 52 or 53.
  527. </p>
  528. <remark>
  529. The first week of the year is determined according to the ISO 8601 standard:
  530. It is the first week that has at least 4 days in it, i.e. it includes a
  531. thursday.
  532. </remark>
  533. </descr>
  534. <seealso>
  535. <link id="WeeksInYear"/>
  536. <link id="DaysInYear"/>
  537. <link id="DaysInAYear"/>
  538. <link id="DaysInMonth"/>
  539. <link id="DaysInAMonth"/>
  540. </seealso>
  541. <example file="datutex/ex13"/>
  542. </element>
  543. <!-- function result Visibility: default -->
  544. <element name="WeeksInAYear.Result">
  545. <short>Number of weeks in <var>AYear</var></short>
  546. </element>
  547. <!-- argument Visibility: default -->
  548. <element name="WeeksInAYear.AYear">
  549. <short>A (valid) year.</short>
  550. </element>
  551. <!-- function Visibility: default -->
  552. <element name="DaysInYear">
  553. <short>Return the number of days in the year in which a date occurs.</short>
  554. <descr>
  555. <p>
  556. <var>daysInYear</var> returns the number of days in the year part of
  557. <var>AValue</var>. The return value is either 365 or 366.
  558. </p>
  559. </descr>
  560. <seealso>
  561. <link id="WeeksInAYear"/>
  562. <link id="WeeksInYear"/>
  563. <link id="DaysInAYear"/>
  564. <link id="DaysInMonth"/>
  565. <link id="DaysInAMonth"/>
  566. </seealso>
  567. <example file="datutex/ex14"/>
  568. </element>
  569. <!-- function result Visibility: default -->
  570. <element name="DaysInYear.Result">
  571. <short>Number of days in the year in which <var>AValue</var> occurs.</short>
  572. </element>
  573. <!-- argument Visibility: default -->
  574. <element name="DaysInYear.AValue">
  575. <short>Date in year of which to calculate the number of days.</short>
  576. </element>
  577. <!-- function Visibility: default -->
  578. <element name="DaysInAYear">
  579. <short>Number of days in a particular year.</short>
  580. <descr>
  581. <p>
  582. <var>DaysInAYear</var> returns the number of weeks in the year
  583. <var>AYear</var>. The return value is either 365 or 366.
  584. </p>
  585. </descr>
  586. <seealso>
  587. <link id="WeeksInAYear"/>
  588. <link id="WeeksInYear"/>
  589. <link id="DaysInYear"/>
  590. <link id="DaysInMonth"/>
  591. <link id="DaysInAMonth"/>
  592. </seealso>
  593. <example file="datutex/ex15"/>
  594. </element>
  595. <!-- function result Visibility: default -->
  596. <element name="DaysInAYear.Result">
  597. <short>Number of days in year <var>AYear</var>.</short>
  598. </element>
  599. <!-- argument Visibility: default -->
  600. <element name="DaysInAYear.AYear">
  601. <short>Year to return the number of days from</short>
  602. </element>
  603. <!-- function Visibility: default -->
  604. <element name="DaysInMonth">
  605. <short>Return the number of days in the month in which a date occurs.</short>
  606. <descr>
  607. <p>
  608. <var>DaysInMonth</var> returns the number of days in the month in which
  609. <var>AValue</var> falls. The return value takes leap years into account.
  610. </p>
  611. </descr>
  612. <seealso>
  613. <link id="WeeksInAYear"/>
  614. <link id="WeeksInYear"/>
  615. <link id="DaysInYear"/>
  616. <link id="DaysInAYear"/>
  617. <link id="DaysInAMonth"/>
  618. </seealso>
  619. <example file="datutex/ex16"/>
  620. </element>
  621. <!-- function result Visibility: default -->
  622. <element name="DaysInMonth.Result">
  623. <short>Number of days in the month in which <var>AValue</var> occurs.</short>
  624. </element>
  625. <!-- argument Visibility: default -->
  626. <element name="DaysInMonth.AValue">
  627. <short>Date in month of which to calculate the number of days.</short>
  628. </element>
  629. <!-- function Visibility: default -->
  630. <element name="DaysInAMonth">
  631. <short>Number of days in a month of a certain year.</short>
  632. <descr>
  633. <p>
  634. <var>DaysInYMonth</var> returns the number of days in the month
  635. <var>AMonth</var> in the year<var>AYear</var>.
  636. The return value takes leap years into account.
  637. </p>
  638. </descr>
  639. <seealso>
  640. <link id="WeeksInAYear"/>
  641. <link id="WeeksInYear"/>
  642. <link id="DaysInYear"/>
  643. <link id="DaysInAYear"/>
  644. <link id="DaysInMonth"/>
  645. </seealso>
  646. <example file="datutex/ex17"/>
  647. </element>
  648. <!-- function result Visibility: default -->
  649. <element name="DaysInAMonth.Result">
  650. <short>The number of days in month <var>AMonth</var>, in year <var>AYear</var>.</short>
  651. </element>
  652. <!-- argument Visibility: default -->
  653. <element name="DaysInAMonth.AYear">
  654. <short>Year in which the month occurs.</short>
  655. </element>
  656. <!-- argument Visibility: default -->
  657. <element name="DaysInAMonth.AMonth">
  658. <short>Month of which the number of days should be returned.</short>
  659. </element>
  660. <!-- function Visibility: default -->
  661. <element name="Today">
  662. <short>Return the current date</short>
  663. <descr>
  664. <p>
  665. <var>Today</var> is an alias for the <link
  666. id="#rtl.sysutils.Date">Date</link> function in the <link
  667. id="#rtl.sysutils">sysutils</link> unit.
  668. </p>
  669. <p>
  670. For an example, see <link id="Yesterday"/>
  671. </p>
  672. </descr>
  673. <seealso>
  674. <link id="#rtl.sysutils.Date">Date</link>
  675. <link id="Yesterday"/>
  676. <link id="Tomorrow"/>
  677. </seealso>
  678. </element>
  679. <!-- function result Visibility: default -->
  680. <element name="Today.Result">
  681. <short>Current day as <var>TDateTime</var>.</short>
  682. </element>
  683. <!-- function Visibility: default -->
  684. <element name="Yesterday">
  685. <short>Return the previous day.</short>
  686. <descr>
  687. <var>Yesterday</var> returns yesterday's date. Yesterday is determined from
  688. the system clock, i.e. it is <link id="Today"/> -1.
  689. </descr>
  690. <seealso>
  691. <link id="Today"/>
  692. <link id="Tomorrow"/>
  693. </seealso>
  694. <example file="datutex/ex18"/>
  695. </element>
  696. <!-- function result Visibility: default -->
  697. <element name="Yesterday.Result">
  698. <short>Previous day as <var>TDateTime</var>.</short>
  699. </element>
  700. <!-- function Visibility: default -->
  701. <element name="Tomorrow">
  702. <short>Return the next day</short>
  703. <descr>
  704. <var>Tomorrow</var> returns tomorrow's date. Tomorrow is determined from
  705. the system clock, i.e. it is <link id="Today"/> +1.
  706. </descr>
  707. <seealso>
  708. <link id="Today"/>
  709. <link id="Yesterday"/>
  710. </seealso>
  711. <example file="datutex/ex19"/>
  712. </element>
  713. <!-- function result Visibility: default -->
  714. <element name="Tomorrow.Result">
  715. <short>Next day as <var>TDateTime</var>.</short>
  716. </element>
  717. <!-- function Visibility: default -->
  718. <element name="IsToday">
  719. <short>Check whether a given date is today.</short>
  720. <descr>
  721. <var>IsToday</var> returns <var>True</var> if <var>AValue</var> is today's
  722. date, and <var>False</var> otherwise.
  723. </descr>
  724. <seealso>
  725. <link id="Today"/>
  726. <link id="Yesterday"/>
  727. <link id="Tomorrow"/>
  728. <link id="IsSameDay"/>
  729. </seealso>
  730. <example file="datutex/ex20"/>
  731. </element>
  732. <!-- function result Visibility: default -->
  733. <element name="IsToday.Result">
  734. <short><var>True</var> if <var>AValue</var> is today, <var>False</var> otherwise.</short>
  735. </element>
  736. <!-- argument Visibility: default -->
  737. <element name="IsToday.AValue">
  738. <short>Date to check, may contain a time part.</short>
  739. </element>
  740. <!-- function Visibility: default -->
  741. <element name="IsSameDay">
  742. <short>Check if two date/time indications are the same day.</short>
  743. <descr>
  744. <var>IsSameDay</var> checks whether <var>AValue</var> and <var>ABasis</var>
  745. have the same date part, and returns <var>True</var> if they do,
  746. <var>False</var> if not.
  747. </descr>
  748. <seealso>
  749. <link id="Today"/>
  750. <link id="Yesterday"/>
  751. <link id="Tomorrow"/>
  752. <link id="IsToday"/>
  753. </seealso>
  754. <example file="datutex/ex21"/>
  755. </element>
  756. <!-- function result Visibility: default -->
  757. <element name="IsSameDay.Result">
  758. <short><var>True</var> if <var>AValue</var> and <var>ABasis</var> are on the same
  759. day, <var>False</var> otherwise..</short>
  760. </element>
  761. <!-- argument Visibility: default -->
  762. <element name="IsSameDay.AValue">
  763. <short>First date/time</short>
  764. </element>
  765. <!-- argument Visibility: default -->
  766. <element name="IsSameDay.ABasis">
  767. <short>Second date/time</short>
  768. </element>
  769. <!-- function Visibility: default -->
  770. <element name="PreviousDayOfWeek">
  771. <short>Given a day of the week, return the previous day of the week.</short>
  772. <descr>
  773. <p>
  774. <var>PreviousDayOfWeek</var> returns the previous day of the week. If the
  775. current day is the first day of the week (1) then the last day will be
  776. returned (7).
  777. </p>
  778. <remark>
  779. Note that the days of the week are in ISO notation, i.e. 1-based.
  780. </remark>
  781. </descr>
  782. <seealso>
  783. <link id="Yesterday"/>
  784. </seealso>
  785. <example file="datutex/ex22"/>
  786. </element>
  787. <!-- function result Visibility: default -->
  788. <element name="PreviousDayOfWeek.Result">
  789. <short>The day of the week prior to <var>DayOfWeek</var></short>
  790. </element>
  791. <!-- argument Visibility: default -->
  792. <element name="PreviousDayOfWeek.DayOfWeek">
  793. <short>Day of the week.</short>
  794. </element>
  795. <!-- function Visibility: default -->
  796. <element name="YearOf">
  797. <short>Extract the year from a given date.</short>
  798. <descr>
  799. <var>YearOf</var> returns the year part of the <var>AValue</var> date/time
  800. indication. It is a number between 1 and 9999.
  801. </descr>
  802. <seealso>
  803. <link id="MonthOf"/>
  804. <link id="DayOf"/>
  805. <link id="WeekOf"/>
  806. <link id="HourOf"/>
  807. <link id="MinuteOf"/>
  808. <link id="SecondOf"/>
  809. <link id="MilliSecondOf"/>
  810. </seealso>
  811. <example file="datutex/ex23"/>
  812. </element>
  813. <!-- function result Visibility: default -->
  814. <element name="YearOf.Result">
  815. <short>Year part of <var>AValue</var></short>
  816. <descr/>
  817. </element>
  818. <!-- argument Visibility: default -->
  819. <element name="YearOf.AValue">
  820. <short>Date to extract year from.</short>
  821. </element>
  822. <!-- function Visibility: default -->
  823. <element name="MonthOf">
  824. <short>Extract the month from a given date.</short>
  825. <descr>
  826. <p>
  827. <var>MonthOf</var> returns the month part of the <var>AValue</var> date/time
  828. indication. It is a number between 1 and 12.
  829. </p>
  830. <p>
  831. For an example, see <link id="YearOf"/>
  832. </p>
  833. </descr>
  834. <seealso>
  835. <link id="YearOf"/>
  836. <link id="DayOf"/>
  837. <link id="WeekOf"/>
  838. <link id="HourOf"/>
  839. <link id="MinuteOf"/>
  840. <link id="SecondOf"/>
  841. <link id="MilliSecondOf"/>
  842. </seealso>
  843. </element>
  844. <!-- function result Visibility: default -->
  845. <element name="MonthOf.Result">
  846. <short>Month part of <var>AValue</var></short>
  847. </element>
  848. <!-- argument Visibility: default -->
  849. <element name="MonthOf.AValue">
  850. <short>Date to extract month from.</short>
  851. </element>
  852. <!-- function Visibility: default -->
  853. <element name="WeekOf">
  854. <short>Extract week (of the year) from a given date.</short>
  855. <descr>
  856. <p>
  857. <var>WeekOf</var> returns the week-of-the-year part of the <var>AValue</var> date/time
  858. indication. It is a number between 1 and 53.
  859. </p>
  860. <p>
  861. For an example, see <link id="YearOf"/>
  862. </p>
  863. </descr>
  864. <seealso>
  865. <link id="YearOf"/>
  866. <link id="DayOf"/>
  867. <link id="MonthOf"/>
  868. <link id="HourOf"/>
  869. <link id="MinuteOf"/>
  870. <link id="SecondOf"/>
  871. <link id="MilliSecondOf"/>
  872. </seealso>
  873. </element>
  874. <!-- function result Visibility: default -->
  875. <element name="WeekOf.Result">
  876. <short>Week part of <var>AValue</var>.</short>
  877. </element>
  878. <!-- argument Visibility: default -->
  879. <element name="WeekOf.AValue">
  880. <short>Date to extract week from.</short>
  881. </element>
  882. <!-- function Visibility: default -->
  883. <element name="DayOf">
  884. <short>Extract the day (of month) part from a DateTime value</short>
  885. <descr>
  886. <p>
  887. <var>DayOf</var> returns the day of the month part of the <var>AValue</var> date/time
  888. indication. It is a number between 1 and 31.
  889. </p>
  890. <p>
  891. For an example, see <link id="YearOf"/>
  892. </p>
  893. </descr>
  894. <seealso>
  895. <link id="YearOf"/>
  896. <link id="WeekOf"/>
  897. <link id="MonthOf"/>
  898. <link id="HourOf"/>
  899. <link id="MinuteOf"/>
  900. <link id="SecondOf"/>
  901. <link id="MilliSecondOf"/>
  902. </seealso>
  903. </element>
  904. <!-- function result Visibility: default -->
  905. <element name="DayOf.Result">
  906. <short>Day of month part of <var>AValue</var>.</short>
  907. </element>
  908. <!-- argument Visibility: default -->
  909. <element name="DayOf.AValue">
  910. <short>Date to extract day of.</short>
  911. </element>
  912. <!-- function Visibility: default -->
  913. <element name="HourOf">
  914. <short>Extract the hour part from a DateTime value.</short>
  915. <descr>
  916. <p>
  917. <var>HourOf</var> returns the hour of the day part of the <var>AValue</var> date/time
  918. indication. It is a number between 0 and 23.
  919. </p>
  920. <p>
  921. For an example, see <link id="YearOf"/>
  922. </p>
  923. </descr>
  924. <seealso>
  925. <link id="YearOf"/>
  926. <link id="WeekOf"/>
  927. <link id="MonthOf"/>
  928. <link id="DayOf"/>
  929. <link id="MinuteOf"/>
  930. <link id="SecondOf"/>
  931. <link id="MilliSecondOf"/>
  932. </seealso>
  933. </element>
  934. <!-- function result Visibility: default -->
  935. <element name="HourOf.Result">
  936. <short>Hour part of <var>AValue</var>.</short>
  937. </element>
  938. <!-- argument Visibility: default -->
  939. <element name="HourOf.AValue">
  940. <short>Date/time value to extract hour from.</short>
  941. </element>
  942. <!-- function Visibility: default -->
  943. <element name="MinuteOf">
  944. <short>Extract the minute part from a DateTime value.</short>
  945. <descr>
  946. <p>
  947. <var>MinuteOf</var> returns the minute of the hour part of the <var>AValue</var> date/time
  948. indication. It is a number between 0 and 59.
  949. </p>
  950. <p>
  951. For an example, see <link id="YearOf"/>
  952. </p>
  953. </descr>
  954. <seealso>
  955. <link id="YearOf"/>
  956. <link id="WeekOf"/>
  957. <link id="MonthOf"/>
  958. <link id="DayOf"/>
  959. <link id="HourOf"/>
  960. <link id="SecondOf"/>
  961. <link id="MilliSecondOf"/>
  962. </seealso>
  963. </element>
  964. <!-- function result Visibility: default -->
  965. <element name="MinuteOf.Result">
  966. <short>Minute part of <var>AValue</var>.</short>
  967. </element>
  968. <!-- argument Visibility: default -->
  969. <element name="MinuteOf.AValue">
  970. <short>Date/time value to extract minute from.</short>
  971. </element>
  972. <!-- function Visibility: default -->
  973. <element name="SecondOf">
  974. <short>Extract the second part from a DateTime value.</short>
  975. <descr>
  976. <p>
  977. <var>SecondOf</var> returns the second of the minute part of the <var>AValue</var> date/time
  978. indication. It is a number between 0 and 59.
  979. </p>
  980. <p>
  981. For an example, see <link id="YearOf"/>
  982. </p>
  983. </descr>
  984. <seealso>
  985. <link id="YearOf"/>
  986. <link id="WeekOf"/>
  987. <link id="MonthOf"/>
  988. <link id="DayOf"/>
  989. <link id="HourOf"/>
  990. <link id="MinuteOf"/>
  991. <link id="MilliSecondOf"/>
  992. </seealso>
  993. </element>
  994. <!-- function result Visibility: default -->
  995. <element name="SecondOf.Result">
  996. <short>Second part of <var>AValue</var>.</short>
  997. </element>
  998. <!-- argument Visibility: default -->
  999. <element name="SecondOf.AValue">
  1000. <short>Date/time value to extract second from.</short>
  1001. </element>
  1002. <!-- function Visibility: default -->
  1003. <element name="MilliSecondOf">
  1004. <short>Extract the millisecond part from a DateTime value.</short>
  1005. <descr>
  1006. <p>
  1007. <var>MillisecondOf</var> returns the second of the minute part of the <var>AValue</var> date/time
  1008. indication. It is a number between 0 and 999.
  1009. </p>
  1010. <p>
  1011. For an example, see <link id="YearOf"/>
  1012. </p>
  1013. </descr>
  1014. <seealso>
  1015. <link id="YearOf"/>
  1016. <link id="WeekOf"/>
  1017. <link id="MonthOf"/>
  1018. <link id="DayOf"/>
  1019. <link id="HourOf"/>
  1020. <link id="MinuteOf"/>
  1021. <link id="MilliSecondOf"/>
  1022. </seealso>
  1023. </element>
  1024. <!-- function result Visibility: default -->
  1025. <element name="MilliSecondOf.Result">
  1026. <short>Millisecond part of <var>AValue</var>.</short>
  1027. </element>
  1028. <!-- argument Visibility: default -->
  1029. <element name="MilliSecondOf.AValue">
  1030. <short>Date/time value to extract millisecond from.</short>
  1031. </element>
  1032. <!-- function Visibility: default -->
  1033. <element name="StartOfTheYear">
  1034. <short>Return the first day of the year, given a date in this year.</short>
  1035. <descr>
  1036. <var>StartOfTheYear</var> extracts the year part of <var>AValue</var> and
  1037. returns a <var>TDateTime</var> value with the date of the first day of that year (January 1), as the
  1038. <link id="StartOfAYear"/> function.
  1039. </descr>
  1040. <seealso>
  1041. <link id="StartOfAYear"/>
  1042. <link id="EndOfTheYear"/>
  1043. <link id="EndOfAYear"/>
  1044. </seealso>
  1045. <example file="datutex/ex24"/>
  1046. </element>
  1047. <!-- function result Visibility: default -->
  1048. <element name="StartOfTheYear.Result">
  1049. <short>First day of the year as a <var>TDateTime</var> value.</short>
  1050. <descr/>
  1051. </element>
  1052. <!-- argument Visibility: default -->
  1053. <element name="StartOfTheYear.AValue">
  1054. <short>Date in year of which to return the start </short>
  1055. <descr/>
  1056. </element>
  1057. <!-- function Visibility: default -->
  1058. <element name="EndOfTheYear">
  1059. <short>Calculate a DateTime value representing the last day of a year, given a date in that year.</short>
  1060. <descr>
  1061. <var>EndOfTheYear</var> extracts the year part of <var>AValue</var> and
  1062. returns a <var>TDateTime</var> value with the date of the last day of that year (December 31), as the
  1063. <link id="EndOfAYear"/> function.
  1064. </descr>
  1065. <seealso>
  1066. <link id="StartOfAYear"/>
  1067. <link id="StartOfTheYear"/>
  1068. <link id="EndOfTheMonth"/>
  1069. <link id="EndOfAMonth"/>
  1070. <link id="StartOfAWeek"/>
  1071. <link id="StartOfTheWeek"/>
  1072. <link id="EndOfAYear"/>
  1073. </seealso>
  1074. <example file="datutex/ex25"/>
  1075. </element>
  1076. <!-- function result Visibility: default -->
  1077. <element name="EndOfTheYear.Result">
  1078. <short>DateTime value representing the end of the year in which <var>AValue</var> falls.</short>
  1079. </element>
  1080. <!-- argument Visibility: default -->
  1081. <element name="EndOfTheYear.AValue">
  1082. <short>Date in the year of which the end should be calculated</short>
  1083. </element>
  1084. <!-- function Visibility: default -->
  1085. <element name="StartOfAYear">
  1086. <short>Return the first day of a given year.</short>
  1087. <descr>
  1088. <var>StartOfAYear</var> returns a <var>TDateTime</var> value with the date of the first day of the year <var>AYear</var> (January 1).
  1089. </descr>
  1090. <seealso>
  1091. <link id="StartOfTheYear"/>
  1092. <link id="EndOfTheYear"/>
  1093. <link id="EndOfAYear"/>
  1094. <link id="EndOfTheMonth"/>
  1095. <link id="EndOfAMonth"/>
  1096. <link id="StartOfAWeek"/>
  1097. <link id="StartOfTheWeek"/>
  1098. </seealso>
  1099. <example file="datutex/ex26"/>
  1100. </element>
  1101. <!-- function result Visibility: default -->
  1102. <element name="StartOfAYear.Result">
  1103. <short>First day of <var>AYear</var> as a <var>TDateTime</var></short>
  1104. </element>
  1105. <!-- argument Visibility: default -->
  1106. <element name="StartOfAYear.AYear">
  1107. <short>Year to get first date from.</short>
  1108. </element>
  1109. <!-- function Visibility: default -->
  1110. <element name="EndOfAYear">
  1111. <short>Calculate a DateTime value representing the last day of a year</short>
  1112. <descr>
  1113. <var>StartOfAYear</var>
  1114. returns a <var>TDateTime</var> value with the date of the last day of the year <var>AYear</var> (December 31).
  1115. </descr>
  1116. <seealso>
  1117. <link id="StartOfTheYear"/>
  1118. <link id="EndOfTheYear"/>
  1119. <link id="EndOfAYear"/>
  1120. <link id="EndOfTheMonth"/>
  1121. <link id="EndOfAMonth"/>
  1122. <link id="StartOfAWeek"/>
  1123. <link id="StartOfTheWeek"/>
  1124. </seealso>
  1125. <example file="datutex/ex27"/>
  1126. </element>
  1127. <!-- function result Visibility: default -->
  1128. <element name="EndOfAYear.Result">
  1129. <short>DateTime representing the last day of <var>AYear</var>.</short>
  1130. </element>
  1131. <!-- argument Visibility: default -->
  1132. <element name="EndOfAYear.AYear">
  1133. <short>Year to calculate last day from</short>
  1134. </element>
  1135. <!-- function Visibility: default -->
  1136. <element name="StartOfTheMonth">
  1137. <short>Calculate the first day of the month, given a date in that month.</short>
  1138. <descr>
  1139. <var>StartOfTheMonth</var> extracts the year and month parts of <var>AValue</var> and
  1140. returns a <var>TDateTime</var> value with the date of the first day of that year
  1141. and month as the <link id="StartOfAMonth"/> function.
  1142. </descr>
  1143. <seealso>
  1144. <link id="StartOfAMonth"/>
  1145. <link id="EndOfTheYear"/>
  1146. <link id="EndOfAYear"/>
  1147. <link id="EndOfTheMonth"/>
  1148. <link id="EndOfAMonth"/>
  1149. <link id="StartOfAWeek"/>
  1150. <link id="StartOfTheWeek"/>
  1151. </seealso>
  1152. <example file="datutex/ex28"/>
  1153. </element>
  1154. <!-- function result Visibility: default -->
  1155. <element name="StartOfTheMonth.Result">
  1156. <short>First day of month as a <var>TDateTime</var> value.</short>
  1157. </element>
  1158. <!-- argument Visibility: default -->
  1159. <element name="StartOfTheMonth.AValue">
  1160. <short>Date to return first of month from</short>
  1161. </element>
  1162. <!-- function Visibility: default -->
  1163. <element name="EndOfTheMonth">
  1164. <short>Calculate a DateTime value representing the last day of the month, given a day in that month.</short>
  1165. <descr>
  1166. <var>EndOfTheMonth</var> extracts the year and month parts of <var>AValue</var> and
  1167. returns a <var>TDateTime</var> value with the date of the first day of that year
  1168. and month as the <link id="EndOfAMonth"/> function.
  1169. </descr>
  1170. <seealso>
  1171. <link id="StartOfAMonth"/>
  1172. <link id="StartOfTheMonth"/>
  1173. <link id="EndOfAMonth"/>
  1174. <link id="EndOfTheYear"/>
  1175. <link id="EndOfAYear"/>
  1176. <link id="StartOfAWeek"/>
  1177. <link id="StartOfTheWeek"/>
  1178. </seealso>
  1179. <example file="datutex/ex29"/>
  1180. </element>
  1181. <!-- function result Visibility: default -->
  1182. <element name="EndOfTheMonth.Result">
  1183. <short>DateTime value representing the last day of the month in which <var>AVAlue</var> is a day.</short>
  1184. </element>
  1185. <!-- argument Visibility: default -->
  1186. <element name="EndOfTheMonth.AValue">
  1187. <short>Day in the month of which the last day should be returned.</short>
  1188. </element>
  1189. <!-- function Visibility: default -->
  1190. <element name="StartOfAMonth">
  1191. <short>Return first date of month, given a year/month pair.</short>
  1192. <descr>
  1193. <var>StartOfAMonth</var> e
  1194. returns a <var>TDateTime</var> value with the date of the first day of the
  1195. month indicated by the <var>AYear</var>, <var>AMonth</var> pair.
  1196. </descr>
  1197. <seealso>
  1198. <link id="StartOfTheMonth"/>
  1199. <link id="EndOfTheMonth"/>
  1200. <link id="EndOfAMonth"/>
  1201. <link id="EndOfTheYear"/>
  1202. <link id="EndOfAYear"/>
  1203. <link id="StartOfAWeek"/>
  1204. <link id="StartOfTheWeek"/>
  1205. </seealso>
  1206. <example file="datutex/ex30"/>
  1207. </element>
  1208. <!-- function result Visibility: default -->
  1209. <element name="StartOfAMonth.Result">
  1210. <short>First day of the month <var>AMonth</var> in <var>AYear</var></short>
  1211. </element>
  1212. <!-- argument Visibility: default -->
  1213. <element name="StartOfAMonth.AYear">
  1214. <short>A year.</short>
  1215. </element>
  1216. <!-- argument Visibility: default -->
  1217. <element name="StartOfAMonth.AMonth">
  1218. <short>Month in the year.</short>
  1219. </element>
  1220. <!-- function Visibility: default -->
  1221. <element name="EndOfAMonth">
  1222. <short>Calculate a datetime value representing the last day of the indicated month</short>
  1223. <descr>
  1224. <var>EndOfAMonth</var> e
  1225. returns a <var>TDateTime</var> value with the date of the last day of the
  1226. month indicated by the <var>AYear</var>, <var>AMonth</var> pair.
  1227. </descr>
  1228. <seealso>
  1229. <link id="StartOfTheMonth"/>
  1230. <link id="StartOfAMonth"/>
  1231. <link id="EndOfTheMonth"/>
  1232. <link id="EndOfTheYear"/>
  1233. <link id="EndOfAYear"/>
  1234. <link id="StartOfAWeek"/>
  1235. <link id="StartOfTheWeek"/>
  1236. </seealso>
  1237. <example file="datutex/ex31"/>
  1238. </element>
  1239. <!-- function result Visibility: default -->
  1240. <element name="EndOfAMonth.Result">
  1241. <short>DateTime value indicating the last day of <var>AMonth</var> in year <var>AYear</var>.</short>
  1242. </element>
  1243. <!-- argument Visibility: default -->
  1244. <element name="EndOfAMonth.AYear">
  1245. <short>Year in which month occurs</short>
  1246. </element>
  1247. <!-- argument Visibility: default -->
  1248. <element name="EndOfAMonth.AMonth">
  1249. <short>Month to calculate end of</short>
  1250. </element>
  1251. <!-- function Visibility: default -->
  1252. <element name="StartOfTheWeek">
  1253. <short>Return the first day of the week, given a date.</short>
  1254. <descr>
  1255. <var>StartOfTheWeek</var> extracts the year and week parts of <var>AValue</var> and
  1256. returns a <var>TDateTime</var> value with the date of the first day of that
  1257. week as the <link id="StartOfAWeek"/> function.
  1258. </descr>
  1259. <seealso>
  1260. <link id="StartOfAWeek"/>
  1261. <link id="EndOfTheWeek"/>
  1262. <link id="EndOfAWeek"/>
  1263. <link id="StartOfAMonth"/>
  1264. <link id="EndOfTheYear"/>
  1265. <link id="EndOfAYear"/>
  1266. <link id="EndOfTheMonth"/>
  1267. <link id="EndOfAMonth"/>
  1268. </seealso>
  1269. <example file="datutex/ex32"/>
  1270. </element>
  1271. <!-- function result Visibility: default -->
  1272. <element name="StartOfTheWeek.Result">
  1273. <short>First day of the week, in <var>TDateTime</var> format.</short>
  1274. </element>
  1275. <!-- argument Visibility: default -->
  1276. <element name="StartOfTheWeek.AValue">
  1277. <short>Day in the week.</short>
  1278. </element>
  1279. <!-- function Visibility: default -->
  1280. <element name="EndOfTheWeek">
  1281. <short>Calculate a DateTime value which represents the end of a week, given a date in that week.</short>
  1282. <descr>
  1283. <var>EndOfTheWeek</var> extracts the year and week parts of <var>AValue</var> and
  1284. returns a <var>TDateTime</var> value with the date of the last day of that
  1285. week as the <link id="EndOfAWeek"/> function.
  1286. </descr>
  1287. <seealso>
  1288. <link id="StartOfAWeek"/>
  1289. <link id="StartOfTheWeek"/>
  1290. <link id="EndOfAWeek"/>
  1291. <link id="StartOfAMonth"/>
  1292. <link id="EndOfTheYear"/>
  1293. <link id="EndOfAYear"/>
  1294. <link id="EndOfTheMonth"/>
  1295. <link id="EndOfAMonth"/>
  1296. </seealso>
  1297. <example file="datutex/ex33"/>
  1298. </element>
  1299. <!-- function result Visibility: default -->
  1300. <element name="EndOfTheWeek.Result">
  1301. <short>DateTime value representing the last day of the week in which <var>AVAlue</var> is a day.</short>
  1302. </element>
  1303. <!-- argument Visibility: default -->
  1304. <element name="EndOfTheWeek.AValue">
  1305. <short>Day in the week of which the last day should be calculated.</short>
  1306. </element>
  1307. <!-- function Visibility: default -->
  1308. <element name="StartOfAWeek">
  1309. <short>Return a day of the week, given a year, week and day in the week.</short>
  1310. <descr>
  1311. <p>
  1312. <var>StartOfAWeek</var>
  1313. returns a <var>TDateTime</var> value with the date of the indicated day of the
  1314. week indicated by the <var>AYear</var>, <var>AWeek</var>,
  1315. <var>ADayOfWeek</var> values.
  1316. </p>
  1317. <p>
  1318. The default value for <var>ADayOfWeek</var> is 1.
  1319. </p>
  1320. </descr>
  1321. <seealso>
  1322. <link id="StartOfTheWeek"/>
  1323. <link id="EndOfTheWeek"/>
  1324. <link id="EndOfAWeek"/>
  1325. <link id="StartOfAMonth"/>
  1326. <link id="EndOfTheYear"/>
  1327. <link id="EndOfAYear"/>
  1328. <link id="EndOfTheMonth"/>
  1329. <link id="EndOfAMonth"/>
  1330. </seealso>
  1331. <example file="datutex/ex34"/>
  1332. </element>
  1333. <!-- function result Visibility: default -->
  1334. <element name="StartOfAWeek.Result">
  1335. <short>First day of the given week, in <var>TDateTime</var> format.</short>
  1336. </element>
  1337. <!-- argument Visibility: default -->
  1338. <element name="StartOfAWeek.AYear">
  1339. <short>Year</short>
  1340. </element>
  1341. <!-- argument Visibility: default -->
  1342. <element name="StartOfAWeek.AWeekOfYear">
  1343. <short>Week in the year</short>
  1344. </element>
  1345. <!-- argument Visibility: default -->
  1346. <element name="StartOfAWeek.ADayOfWeek">
  1347. <short>Day in the week (default 1)</short>
  1348. </element>
  1349. <!-- function Visibility: default -->
  1350. <element name="EndOfAWeek">
  1351. <short>Return the last moment of day of the week, given a year and a week in the year.</short>
  1352. <descr>
  1353. <p>
  1354. <var>EndOfAWeek</var> returns a <var>TDateTime</var> value with the date of the
  1355. last moment (23:59:59:999) on the indicated day of the week indicated by the
  1356. <var>AYear</var>, <var>AWeek</var>, <var>ADayOfWeek</var> values.
  1357. </p>
  1358. <p>
  1359. The default value for <var>ADayOfWeek</var> is 7.
  1360. </p>
  1361. </descr>
  1362. <seealso>
  1363. <link id="StartOfTheWeek"/>
  1364. <link id="EndOfTheWeek"/>
  1365. <link id="EndOfAWeek"/>
  1366. <link id="StartOfAMonth"/>
  1367. <link id="EndOfTheYear"/>
  1368. <link id="EndOfAYear"/>
  1369. <link id="EndOfTheMonth"/>
  1370. <link id="EndOfAMonth"/>
  1371. </seealso>
  1372. <example file="datutex/ex35"/>
  1373. </element>
  1374. <!-- function result Visibility: default -->
  1375. <element name="EndOfAWeek.Result">
  1376. <short></short>
  1377. </element>
  1378. <!-- argument Visibility: default -->
  1379. <element name="EndOfAWeek.AYear">
  1380. <short></short>
  1381. </element>
  1382. <!-- argument Visibility: default -->
  1383. <element name="EndOfAWeek.AWeekOfYear">
  1384. <short></short>
  1385. </element>
  1386. <!-- argument Visibility: default -->
  1387. <element name="EndOfAWeek.ADayOfWeek">
  1388. <short>Day of the week</short>
  1389. </element>
  1390. <!-- function Visibility: default -->
  1391. <element name="StartOfTheDay">
  1392. <short>Calculate the start of the day as a DateTime value, given a moment in the day.</short>
  1393. <descr>
  1394. <p>
  1395. <var>StartOfTheDay</var> extracts the date part of <var>AValue</var> and
  1396. returns a <var>TDateTime</var> value with the date/time indication of
  1397. the start (0:0:0.000) of this day.
  1398. </p>
  1399. </descr>
  1400. <seealso>
  1401. <link id="StartOfADay"/>
  1402. <link id="StartOfTheWeek"/>
  1403. <link id="StartOfAWeek"/>
  1404. <link id="StartOfAMonth"/>
  1405. <link id="StartOfTheMonth"/>
  1406. <link id="EndOfTheWeek"/>
  1407. <link id="EndOfAWeek"/>
  1408. <link id="EndOfTheYear"/>
  1409. <link id="EndOfAYear"/>
  1410. <link id="EndOfTheMonth"/>
  1411. <link id="EndOfAMonth"/>
  1412. <link id="EndOftheDay"/>
  1413. <link id="EndOfADay"/>
  1414. </seealso>
  1415. <example file="datutex/ex36"/>
  1416. </element>
  1417. <!-- function result Visibility: default -->
  1418. <element name="StartOfTheDay.Result">
  1419. <short>Start of the day (00:00) as DateTime value</short>
  1420. </element>
  1421. <!-- argument Visibility: default -->
  1422. <element name="StartOfTheDay.AValue">
  1423. <short>DateTime from which to calculate start of the day.</short>
  1424. </element>
  1425. <!-- function Visibility: default -->
  1426. <element name="EndOfTheDay">
  1427. <short>Calculate a datetime value that represents the end of a given day.</short>
  1428. <descr>
  1429. <p>
  1430. <var>EndOfTheDay</var> extracts the date part of <var>AValue</var> and
  1431. returns a <var>TDateTime</var> value with the date/time indication of
  1432. the last moment (23:59:59.999) of this day.
  1433. </p>
  1434. </descr>
  1435. <seealso>
  1436. <link id="StartOftheDay"/>
  1437. <link id="StartOfADay"/>
  1438. <link id="StartOfTheWeek"/>
  1439. <link id="StartOfAWeek"/>
  1440. <link id="StartOfAMonth"/>
  1441. <link id="StartOfTheMonth"/>
  1442. <link id="EndOfTheWeek"/>
  1443. <link id="EndOfAWeek"/>
  1444. <link id="EndOfTheYear"/>
  1445. <link id="EndOfAYear"/>
  1446. <link id="EndOfTheMonth"/>
  1447. <link id="EndOfAMonth"/>
  1448. <link id="EndOfADay"/>
  1449. </seealso>
  1450. <example file="datutex/ex37"/>
  1451. </element>
  1452. <!-- function result Visibility: default -->
  1453. <element name="EndOfTheDay.Result">
  1454. <short>A datetime value representing the time 23:59:59.999 of the day <var>AValue</var>.</short>
  1455. </element>
  1456. <!-- argument Visibility: default -->
  1457. <element name="EndOfTheDay.AValue">
  1458. <short>Day to calculate the end of</short>
  1459. </element>
  1460. <!-- function Visibility: default -->
  1461. <element name="StartOfADay">
  1462. <short>Return the start of a day as a DateTime value, given a day indication</short>
  1463. <descr>
  1464. <p>
  1465. <var>StartOfADay</var>
  1466. returns a <var>TDateTime</var> value with the date/time indication of
  1467. the start (0:0:0.000) of the day given by <var>AYear</var>,
  1468. <var>AMonth</var>, <var>ADay</var>.
  1469. </p>
  1470. <p>
  1471. The day may also be indicated with a <var>AYear</var>, <var>ADayOfYear</var> pair.
  1472. </p>
  1473. </descr>
  1474. <seealso>
  1475. <link id="StartOfTheDay"/>
  1476. <link id="StartOfTheWeek"/>
  1477. <link id="StartOfAWeek"/>
  1478. <link id="StartOfAMonth"/>
  1479. <link id="StartOfTheMonth"/>
  1480. <link id="EndOfTheWeek"/>
  1481. <link id="EndOfAWeek"/>
  1482. <link id="EndOfTheYear"/>
  1483. <link id="EndOfAYear"/>
  1484. <link id="EndOfTheMonth"/>
  1485. <link id="EndOfAMonth"/>
  1486. <link id="EndOfTheDay"/>
  1487. <link id="EndOfADay"/>
  1488. </seealso>
  1489. <example file="datutex/ex38"/>
  1490. </element>
  1491. <!-- function result Visibility: default -->
  1492. <element name="StartOfADay.Result">
  1493. <short>Start of the given day as DateTime</short>
  1494. </element>
  1495. <!-- argument Visibility: default -->
  1496. <element name="StartOfADay.AYear">
  1497. <short>Year</short>
  1498. </element>
  1499. <!-- argument Visibility: default -->
  1500. <element name="StartOfADay.AMonth">
  1501. <short>Month in the year</short>
  1502. </element>
  1503. <!-- argument Visibility: default -->
  1504. <element name="StartOfADay.ADay">
  1505. <short>Day in the month.</short>
  1506. </element>
  1507. <!-- argument Visibility: default -->
  1508. <element name="StartOfADay.ADayOfYear">
  1509. <short>Day in the year.</short>
  1510. </element>
  1511. <!-- function Visibility: default -->
  1512. <element name="EndOfADay">
  1513. <short>Calculates a DateTime value representing the end of a specified day</short>
  1514. <descr>
  1515. <p>
  1516. <var>EndOfADay</var>
  1517. returns a <var>TDateTime</var> value with the date/time indication of
  1518. the last moment (23:59:59.999) of the day given by <var>AYear</var>,
  1519. <var>AMonth</var>, <var>ADay</var>.
  1520. </p>
  1521. <p>
  1522. The day may also be indicated with a <var>AYear</var>, <var>ADayOfYear</var> pair.
  1523. </p>
  1524. </descr>
  1525. <seealso>
  1526. <link id="StartOfTheDay"/>
  1527. <link id="StartOfADay"/>
  1528. <link id="StartOfTheWeek"/>
  1529. <link id="StartOfAWeek"/>
  1530. <link id="StartOfAMonth"/>
  1531. <link id="StartOfTheMonth"/>
  1532. <link id="EndOfTheWeek"/>
  1533. <link id="EndOfAWeek"/>
  1534. <link id="EndOfTheYear"/>
  1535. <link id="EndOfAYear"/>
  1536. <link id="EndOfTheMonth"/>
  1537. <link id="EndOfAMonth"/>
  1538. <link id="EndOfTheDay"/>
  1539. </seealso>
  1540. <example file="datutex/ex39"/>
  1541. </element>
  1542. <!-- function result Visibility: default -->
  1543. <element name="EndOfADay.Result">
  1544. <short>A datetime value representing the time 23:59:59.999 of the given day.</short>
  1545. </element>
  1546. <!-- argument Visibility: default -->
  1547. <element name="EndOfADay.AYear">
  1548. <short>Year</short>
  1549. </element>
  1550. <!-- argument Visibility: default -->
  1551. <element name="EndOfADay.AMonth">
  1552. <short>Month in the year</short>
  1553. </element>
  1554. <!-- argument Visibility: default -->
  1555. <element name="EndOfADay.ADay">
  1556. <short>Day in the month</short>
  1557. </element>
  1558. <!-- argument Visibility: default -->
  1559. <element name="EndOfADay.ADayOfYear">
  1560. <short>Day of the year</short>
  1561. </element>
  1562. <!-- function Visibility: default -->
  1563. <element name="MonthOfTheYear">
  1564. <short>Extract the month of a DateTime indication.</short>
  1565. <descr>
  1566. <p>
  1567. <var>MonthOfTheYear</var> extracts the month part of <var>Avalue</var> and
  1568. returns it. It is an alias for <link id="MonthOf"/>, and is provided for
  1569. completeness only, corresponding to the other <var>PartOfTheYear</var> functions.
  1570. </p>
  1571. <p>
  1572. For an example, see the <link id="WeekOfTheYear"/> function.
  1573. </p>
  1574. </descr>
  1575. <seealso>
  1576. <link id="MonthOf"/>
  1577. <link id="WeekOfTheYear"/>
  1578. <link id="DayOfTheYear"/>
  1579. <link id="HourOfTheYear"/>
  1580. <link id="MinuteOfTheYear"/>
  1581. <link id="SecondOfTheYear"/>
  1582. <link id="MilliSecondOfTheYear"/>
  1583. </seealso>
  1584. </element>
  1585. <!-- function result Visibility: default -->
  1586. <element name="MonthOfTheYear.Result">
  1587. <short>The month part of <var>AValue</var></short>
  1588. </element>
  1589. <!-- argument Visibility: default -->
  1590. <element name="MonthOfTheYear.AValue">
  1591. <short>Date from which to extract month</short>
  1592. </element>
  1593. <!-- function Visibility: default -->
  1594. <element name="WeekOfTheYear">
  1595. <short>Extract the week of the year (and optionally year) of a DateTime indication.</short>
  1596. <descr>
  1597. <p>
  1598. <var>WeekOfTheYear</var> extracts the week of the year from <var>Avalue</var> and
  1599. returns it, and optionally returns the year as well. It returns the same value as <link id="WeekOf"/>.
  1600. </p>
  1601. <remark>
  1602. Note that weeks are numbered from 1 using the ISO 8601 standard, and the day of the week as well.
  1603. This means that the year may not be the same as the year part of the date, since the week may
  1604. start in the previous year as the first week of the year is the week with at
  1605. least 4 days in it.
  1606. </remark>
  1607. </descr>
  1608. <seealso>
  1609. <link id="WeekOf"/>
  1610. <link id="MonthOfTheYear"/>
  1611. <link id="DayOfTheYear"/>
  1612. <link id="HourOfTheYear"/>
  1613. <link id="MinuteOfTheYear"/>
  1614. <link id="SecondOfTheYear"/>
  1615. <link id="MilliSecondOfTheYear"/>
  1616. </seealso>
  1617. <example file="datutex/ex40"/>
  1618. </element>
  1619. <!-- function result Visibility: default -->
  1620. <element name="WeekOfTheYear.Result">
  1621. <short>Week of the year in which <var>Avalue</var> falls.</short>
  1622. </element>
  1623. <!-- argument Visibility: default -->
  1624. <element name="WeekOfTheYear.AValue">
  1625. <short>Date from which to extract week.</short>
  1626. </element>
  1627. <!-- argument Visibility: default -->
  1628. <element name="WeekOfTheYear.AYear">
  1629. <short>Year part of <var>AValue</var></short>
  1630. </element>
  1631. <!-- function Visibility: default -->
  1632. <element name="DayOfTheYear">
  1633. <short>Extracts the day of the year from a <var>TDateTime</var> value</short>
  1634. <descr>
  1635. <p>
  1636. <var>DayOfTheYear</var> returns the number of days that have passed since
  1637. the start of the year till the moment indicated by
  1638. <var>AValue</var>. This is a one-based number, i.e. January 1 will
  1639. return 1.
  1640. </p>
  1641. <p>
  1642. For an example, see the <link id="WeekOfTheYear"/> function.
  1643. </p>
  1644. </descr>
  1645. <seealso>
  1646. <link id="WeekOfTheYear"/>
  1647. <link id="HourOfTheYear"/>
  1648. <link id="MinuteOfTheYear"/>
  1649. <link id="SecondOfTheYear"/>
  1650. <link id="MilliSecondOfTheYear"/>
  1651. </seealso>
  1652. </element>
  1653. <!-- function result Visibility: default -->
  1654. <element name="DayOfTheYear.Result">
  1655. <short>Day of the year from <var>AValue</var>.</short>
  1656. </element>
  1657. <!-- argument Visibility: default -->
  1658. <element name="DayOfTheYear.AValue">
  1659. <short>DateTime to extract the day of the year from.</short>
  1660. </element>
  1661. <!-- function Visibility: default -->
  1662. <element name="HourOfTheYear">
  1663. <short>Calculate the number of hours passed since the start of the year.</short>
  1664. <descr>
  1665. <p>
  1666. <var>HourOfTheYear</var> returns the number of hours that have passed since
  1667. the start of the year (January 1, 00:00:00) till the moment indicated by
  1668. <var>AValue</var>. This is a zero-based number, i.e.
  1669. January 1 00:59:59 will return 0.
  1670. </p>
  1671. <p>
  1672. For an example, see the <link id="WeekOfTheYear"/> function.
  1673. </p>
  1674. </descr>
  1675. <seealso>
  1676. <link id="WeekOfTheYear"/>
  1677. <link id="DayOfTheYear"/>
  1678. <link id="MinuteOfTheYear"/>
  1679. <link id="SecondOfTheYear"/>
  1680. <link id="MilliSecondOfTheYear"/>
  1681. </seealso>
  1682. </element>
  1683. <!-- function result Visibility: default -->
  1684. <element name="HourOfTheYear.Result">
  1685. <short>Number of hours passed since the start of the year till <var>AValue</var> .</short>
  1686. </element>
  1687. <!-- argument Visibility: default -->
  1688. <element name="HourOfTheYear.AValue">
  1689. <short>DateTime value for which to calculate the hour of the year</short>
  1690. </element>
  1691. <!-- function Visibility: default -->
  1692. <element name="MinuteOfTheYear">
  1693. <short>Calculate the number of minutes elapsed since the start of the year</short>
  1694. <descr>
  1695. <p>
  1696. <var>MinuteOfTheYear</var> returns the number of minutes that have passed since
  1697. the start of the year (January 1, 00:00:00) till the moment indicated by
  1698. <var>AValue</var>. This is a zero-based number, i.e.
  1699. January 1 00:00:59 will return 0.
  1700. </p>
  1701. <p>
  1702. For an example, see the <link id="WeekOfTheYear"/> function.
  1703. </p>
  1704. </descr>
  1705. <seealso>
  1706. <link id="WeekOfTheYear"/>
  1707. <link id="DayOfTheYear"/>
  1708. <link id="HourOfTheYear"/>
  1709. <link id="MinuteOfTheYear"/>
  1710. <link id="SecondOfTheYear"/>
  1711. <link id="MilliSecondOfTheYear"/>
  1712. </seealso>
  1713. </element>
  1714. <!-- function result Visibility: default -->
  1715. <element name="MinuteOfTheYear.Result">
  1716. <short>Number of minutes elapsed since the start of the year.</short>
  1717. </element>
  1718. <!-- argument Visibility: default -->
  1719. <element name="MinuteOfTheYear.AValue">
  1720. <short>Moment in the year.</short>
  1721. </element>
  1722. <!-- function Visibility: default -->
  1723. <element name="SecondOfTheYear">
  1724. <short>Calculate the number of seconds elapsed since the start of the year.</short>
  1725. <descr>
  1726. <p>
  1727. <var>SecondOfTheYear</var> returns the number of seconds that have passed since
  1728. the start of the year (January 1, 00:00:00) till the moment indicated by
  1729. <var>AValue</var>. This is a zero-based number, i.e.
  1730. January 1 00:00:00.999 will return 0.
  1731. </p>
  1732. <p>
  1733. For an example, see the <link id="WeekOfTheYear"/> function.
  1734. </p>
  1735. </descr>
  1736. <seealso>
  1737. <link id="WeekOfTheYear"/>
  1738. <link id="DayOfTheYear"/>
  1739. <link id="HourOfTheYear"/>
  1740. <link id="MinuteOfTheYear"/>
  1741. <link id="SecondOfTheYear"/>
  1742. <link id="MilliSecondOfTheYear"/>
  1743. </seealso>
  1744. </element>
  1745. <!-- function result Visibility: default -->
  1746. <element name="SecondOfTheYear.Result">
  1747. <short>Number of seconds elapsed since the start of the year.</short>
  1748. </element>
  1749. <!-- argument Visibility: default -->
  1750. <element name="SecondOfTheYear.AValue">
  1751. <short>Moment in the year</short>
  1752. </element>
  1753. <!-- function Visibility: default -->
  1754. <element name="MilliSecondOfTheYear">
  1755. <short>Calculate the number of milliseconds elapsed since the start of the year.</short>
  1756. <descr>
  1757. <p>
  1758. <var>MilliSecondOfTheYear</var> returns the number of milliseconds that have passed since
  1759. the start of the year (January 1, 00:00:00.000) till the moment indicated by
  1760. <var>AValue</var>. This is a zero-based number, i.e.
  1761. January 1 00:00:00.000 will return 0.
  1762. </p>
  1763. <p>
  1764. For an example, see the <link id="WeekOfTheYear"/> function.
  1765. </p>
  1766. </descr>
  1767. <seealso>
  1768. <link id="WeekOfTheYear"/>
  1769. <link id="DayOfTheYear"/>
  1770. <link id="HourOfTheYear"/>
  1771. <link id="MinuteOfTheYear"/>
  1772. <link id="SecondOfTheYear"/>
  1773. <link id="MilliSecondOfTheYear"/>
  1774. </seealso>
  1775. </element>
  1776. <!-- function result Visibility: default -->
  1777. <element name="MilliSecondOfTheYear.Result">
  1778. <short>Number of seconds elapsed since the start of the year.</short>
  1779. </element>
  1780. <!-- argument Visibility: default -->
  1781. <element name="MilliSecondOfTheYear.AValue">
  1782. <short>Moment in the year</short>
  1783. </element>
  1784. <!-- function Visibility: default -->
  1785. <element name="WeekOfTheMonth">
  1786. <short>Extract the week of the month (and optionally month and year) from a DateTime value</short>
  1787. <descr>
  1788. <p>
  1789. <var>WeekOfTheMonth</var> extracts the week of the month from <var>Avalue</var> and
  1790. returns it, and optionally returns the year and month as well (in
  1791. <var>AYear</var>, <var>AMonth</var> respectively).
  1792. </p>
  1793. <remark>
  1794. Note that weeks are numbered from 1 using the ISO 8601 standard, and the day of the week as well.
  1795. This means that the year and month may not be the same as the year part of the date, since the week may
  1796. start in the previous year as the first week of the year is the week with at least 4 days in it.
  1797. </remark>
  1798. </descr>
  1799. <seealso>
  1800. <link id="WeekOfTheYear"/>
  1801. <link id="DayOfTheMonth"/>
  1802. <link id="HourOfTheMonth"/>
  1803. <link id="MinuteOfTheMonth"/>
  1804. <link id="SecondOfTheMonth"/>
  1805. <link id="MilliSecondOfTheMonth"/>
  1806. </seealso>
  1807. <example file="datutex/ex41"/>
  1808. </element>
  1809. <!-- function result Visibility: default -->
  1810. <element name="WeekOfTheMonth.Result">
  1811. <short>Week of the month</short>
  1812. </element>
  1813. <!-- argument Visibility: default -->
  1814. <element name="WeekOfTheMonth.AValue">
  1815. <short>Datetime value of which to calculate the week, month and year.</short>
  1816. </element>
  1817. <!-- argument Visibility: default -->
  1818. <element name="WeekOfTheMonth.AYear">
  1819. <short>Year part of <var>AValue</var></short>
  1820. </element>
  1821. <!-- argument Visibility: default -->
  1822. <element name="WeekOfTheMonth.AMonth">
  1823. <short>Month part of <var>AValue</var></short>
  1824. </element>
  1825. <!-- function Visibility: default -->
  1826. <element name="DayOfTheMonth">
  1827. <short>Extract the day (of month) part of a DateTime value</short>
  1828. <descr>
  1829. <p>
  1830. <var>DayOfTheMonth</var> returns the number of days that have passed since
  1831. the start of the month till the moment indicated by
  1832. <var>AValue</var>. This is a one-based number, i.e. the first day of the
  1833. month will return 1.
  1834. </p>
  1835. <p>
  1836. For an example, see the <link id="WeekOfTheMonth"/> function.
  1837. </p>
  1838. </descr>
  1839. <seealso>
  1840. <link id="DayOfTheYear"/>
  1841. <link id="WeekOfTheMonth"/>
  1842. <link id="HourOfTheMonth"/>
  1843. <link id="MinuteOfTheMonth"/>
  1844. <link id="SecondOfTheMonth"/>
  1845. <link id="MilliSecondOfTheMonth"/>
  1846. </seealso>
  1847. </element>
  1848. <!-- function result Visibility: default -->
  1849. <element name="DayOfTheMonth.Result">
  1850. <short>Day in the month</short>
  1851. </element>
  1852. <!-- argument Visibility: default -->
  1853. <element name="DayOfTheMonth.AValue">
  1854. <short>Datetime value to extract day from.</short>
  1855. </element>
  1856. <!-- function Visibility: default -->
  1857. <element name="HourOfTheMonth">
  1858. <short>Calculate the number of hours passed since the start of the month.</short>
  1859. <descr>
  1860. <p>
  1861. <var>HourOfTheMonth</var> returns the number of hours that have passed since
  1862. the start of the month till the moment indicated by
  1863. <var>AValue</var>. This is a zero-based number, i.e.
  1864. 00:59:59 on the first day of the month will return 0.
  1865. </p>
  1866. <p>
  1867. For an example, see the <link id="WeekOfTheMonth"/> function.
  1868. </p>
  1869. </descr>
  1870. <seealso>
  1871. <link id="WeekOfTheMonth"/>
  1872. <link id="DayOfTheMonth"/>
  1873. <link id="MinuteOfTheMonth"/>
  1874. <link id="SecondOfTheMonth"/>
  1875. <link id="MilliSecondOfTheMonth"/>
  1876. </seealso>
  1877. </element>
  1878. <!-- function result Visibility: default -->
  1879. <element name="HourOfTheMonth.Result">
  1880. <short>Number of hours passed since the start of the month till <var>AValue</var>.</short>
  1881. </element>
  1882. <!-- argument Visibility: default -->
  1883. <element name="HourOfTheMonth.AValue">
  1884. <short>DateTime value for which to calculate the hour of the month.</short>
  1885. </element>
  1886. <!-- function Visibility: default -->
  1887. <element name="MinuteOfTheMonth">
  1888. <short>Calculate number of minutes elapsed since the start of the month.</short>
  1889. <descr>
  1890. <p>
  1891. <var>MinuteOfTheMonth</var> returns the number of minutes that have passed since
  1892. the start of the Month (00:00:00) till the moment indicated by
  1893. <var>AValue</var>. This is a zero-based number, i.e.
  1894. 00:00:59 on the first day of the month will return 0.
  1895. </p>
  1896. <p>
  1897. For an example, see the <link id="WeekOfTheMonth"/> function.
  1898. </p>
  1899. </descr>
  1900. <seealso>
  1901. <link id="WeekOfTheMonth"/>
  1902. <link id="DayOfTheMonth"/>
  1903. <link id="HourOfTheMonth"/>
  1904. <link id="MinuteOfTheMonth"/>
  1905. <link id="SecondOfTheMonth"/>
  1906. <link id="MilliSecondOfTheMonth"/>
  1907. </seealso>
  1908. </element>
  1909. <!-- function result Visibility: default -->
  1910. <element name="MinuteOfTheMonth.Result">
  1911. <short>Number of minutes elapsed since the start of the month.</short>
  1912. </element>
  1913. <!-- argument Visibility: default -->
  1914. <element name="MinuteOfTheMonth.AValue">
  1915. <short>Moment in the month.</short>
  1916. </element>
  1917. <!-- function Visibility: default -->
  1918. <element name="SecondOfTheMonth">
  1919. <short>Calculate number of seconds elapsed since the start of the month.</short>
  1920. <descr>
  1921. <p>
  1922. <var>SecondOfTheMonth</var> returns the number of seconds that have passed since
  1923. the start of the month (00:00:00) till the moment indicated by
  1924. <var>AValue</var>. This is a zero-based number, i.e.
  1925. 00:00:00.999 on the first day of the month will return 0.
  1926. </p>
  1927. <p>
  1928. For an example, see the <link id="WeekOfTheMonth"/> function.
  1929. </p>
  1930. </descr>
  1931. <seealso>
  1932. <link id="WeekOfTheMonth"/>
  1933. <link id="DayOfTheMonth"/>
  1934. <link id="HourOfTheMonth"/>
  1935. <link id="MinuteOfTheMonth"/>
  1936. <link id="MilliSecondOfTheMonth"/>
  1937. </seealso>
  1938. </element>
  1939. <!-- function result Visibility: default -->
  1940. <element name="SecondOfTheMonth.Result">
  1941. <short>Number of seconds elapsed since the start of the month.</short>
  1942. </element>
  1943. <!-- argument Visibility: default -->
  1944. <element name="SecondOfTheMonth.AValue">
  1945. <short>Moment in the month.</short>
  1946. </element>
  1947. <!-- function Visibility: default -->
  1948. <element name="MilliSecondOfTheMonth">
  1949. <short>Calculate number of milliseconds elapsed since the start of the month.</short>
  1950. <descr>
  1951. <p>
  1952. <var>MilliSecondOfTheMonth</var> returns the number of milliseconds that have passed since
  1953. the start of the month (00:00:00.000) till the moment indicated by
  1954. <var>AValue</var>. This is a zero-based number, i.e.
  1955. 00:00:00.000 on the first of the month will return 0.
  1956. </p>
  1957. <p>
  1958. For an example, see the <link id="WeekOfTheMonth"/> function.
  1959. </p>
  1960. </descr>
  1961. <seealso>
  1962. <link id="WeekOfTheMonth"/>
  1963. <link id="DayOfTheMonth"/>
  1964. <link id="HourOfTheMonth"/>
  1965. <link id="MinuteOfTheMonth"/>
  1966. <link id="SecondOfTheMonth"/>
  1967. <link id="MilliSecondOfTheMonth"/>
  1968. </seealso>
  1969. </element>
  1970. <!-- function result Visibility: default -->
  1971. <element name="MilliSecondOfTheMonth.Result">
  1972. <short>Number of milliseconds elapsed since the start of the month.</short>
  1973. </element>
  1974. <!-- argument Visibility: default -->
  1975. <element name="MilliSecondOfTheMonth.AValue">
  1976. <short>Moment in the month</short>
  1977. </element>
  1978. <!-- function Visibility: default -->
  1979. <element name="DayOfTheWeek">
  1980. <short>Extracts the day of the week from a DateTime value</short>
  1981. <descr>
  1982. <p>
  1983. <var>DayOfTheWeek</var> returns the number of days that have passed since
  1984. the start of the week till the moment indicated by
  1985. <var>AValue</var>. This is a one-based number, i.e. the first day of the
  1986. week will return 1.
  1987. </p>
  1988. </descr>
  1989. <seealso>
  1990. <link id="DayOfTheYear"/>
  1991. <link id="DayOfTheMonth"/>
  1992. <link id="HourOfTheWeek"/>
  1993. <link id="MinuteOfTheWeek"/>
  1994. <link id="SecondOfTheWeek"/>
  1995. <link id="MilliSecondOfTheWeek"/>
  1996. </seealso>
  1997. <example file="datutex/ex42"/>
  1998. </element>
  1999. <!-- function result Visibility: default -->
  2000. <element name="DayOfTheWeek.Result">
  2001. <short>Day of the week from <var>AValue</var>.</short>
  2002. </element>
  2003. <!-- argument Visibility: default -->
  2004. <element name="DayOfTheWeek.AValue">
  2005. <short>DateTime to extract the day of the week from.</short>
  2006. </element>
  2007. <!-- function Visibility: default -->
  2008. <element name="HourOfTheWeek">
  2009. <short>Calculate the number of hours elapsed since the start of the week.</short>
  2010. <descr>
  2011. <p>
  2012. <var>HourOfTheWeek</var> returns the number of hours that have passed since
  2013. the start of the Week till the moment indicated by
  2014. <var>AValue</var>. This is a zero-based number, i.e.
  2015. 00:59:59 on the first day of the week will return 0.
  2016. </p>
  2017. <p>
  2018. For an example, see the <link id="DayOfTheWeek"/> function.
  2019. </p>
  2020. </descr>
  2021. <seealso>
  2022. <link id="HourOfTheYear"/>
  2023. <link id="HourOfTheMonth"/>
  2024. <link id="HourOfTheDay"/>
  2025. <link id="DayOfTheWeek"/>
  2026. <link id="MinuteOfTheWeek"/>
  2027. <link id="SecondOfTheWeek"/>
  2028. <link id="MilliSecondOfTheWeek"/>
  2029. </seealso>
  2030. </element>
  2031. <!-- function result Visibility: default -->
  2032. <element name="HourOfTheWeek.Result">
  2033. <short>Number of hours elapsed since the start of the week till <var>AValue</var>.</short>
  2034. </element>
  2035. <!-- argument Visibility: default -->
  2036. <element name="HourOfTheWeek.AValue">
  2037. <short>DateTime value for which to calculate the hour of the week.</short>
  2038. </element>
  2039. <!-- function Visibility: default -->
  2040. <element name="MinuteOfTheWeek">
  2041. <short>Calculate the number of minutes elapsed since the start of the week</short>
  2042. <descr>
  2043. <p>
  2044. <var>MinuteOfTheWeek</var> returns the number of minutes that have passed since
  2045. the start of the week (00:00:00) till the moment indicated by
  2046. <var>AValue</var>. This is a zero-based number, i.e.
  2047. 00:00:59 on the first day of the week will return 0.
  2048. </p>
  2049. <p>
  2050. For an example, see the <link id="DayOfTheWeek"/> function.
  2051. </p>
  2052. </descr>
  2053. <seealso>
  2054. <link id="MinuteOfTheYear"/>
  2055. <link id="MinuteOfTheMonth"/>
  2056. <link id="MinuteOfTheDay"/>
  2057. <link id="MinuteOfTheHour"/>
  2058. <link id="DayOfTheWeek"/>
  2059. <link id="HourOfTheWeek"/>
  2060. <link id="SecondOfTheWeek"/>
  2061. <link id="MilliSecondOfTheWeek"/>
  2062. </seealso>
  2063. </element>
  2064. <!-- function result Visibility: default -->
  2065. <element name="MinuteOfTheWeek.Result">
  2066. <short>Number of seconds elapsed since the start of the week</short>
  2067. </element>
  2068. <!-- argument Visibility: default -->
  2069. <element name="MinuteOfTheWeek.AValue">
  2070. <short>Moment in the week.</short>
  2071. </element>
  2072. <element name="SecondOfTheWeek">
  2073. <short>Calculate the number of seconds elapsed since the start of the week</short>
  2074. <descr>
  2075. <p>
  2076. <var>SecondOfTheWeek</var> returns the number of seconds that have passed since
  2077. the start of the week (00:00:00) till the moment indicated by
  2078. <var>AValue</var>. This is a zero-based number, i.e.
  2079. 00:00:00.999 on the first day of the week will return 0.
  2080. </p>
  2081. <p>
  2082. For an example, see the <link id="DayOfTheWeek"/> function.
  2083. </p>
  2084. </descr>
  2085. <seealso>
  2086. <link id="SecondOfTheYear"/>
  2087. <link id="SecondOfTheMonth"/>
  2088. <link id="SecondOfTheDay"/>
  2089. <link id="SecondOfTheHour"/>
  2090. <link id="SecondOfTheMinute"/>
  2091. <link id="DayOfTheWeek"/>
  2092. <link id="HourOfTheWeek"/>
  2093. <link id="MinuteOfTheWeek"/>
  2094. <link id="MilliSecondOfTheWeek"/>
  2095. </seealso>
  2096. </element>
  2097. <!-- function result Visibility: default -->
  2098. <element name="SecondOfTheWeek.Result">
  2099. <short>Number of seconds elapsed since the start of the week</short>
  2100. </element>
  2101. <!-- argument Visibility: default -->
  2102. <element name="SecondOfTheWeek.AValue">
  2103. <short>Moment in the week</short>
  2104. </element>
  2105. <!-- function Visibility: default -->
  2106. <element name="MilliSecondOfTheWeek">
  2107. <short>Calculate the number of milliseconds elapsed since the start of the week</short>
  2108. <descr>
  2109. <p>
  2110. <var>MilliSecondOfTheWeek</var> returns the number of milliseconds that have passed since
  2111. the start of the Week (00:00:00.000) till the moment indicated by
  2112. <var>AValue</var>. This is a zero-based number, i.e.
  2113. 00:00:00.000 on the first of the Week will return 0.
  2114. </p>
  2115. <p>
  2116. For an example, see the <link id="DayOfTheWeek"/> function.
  2117. </p>
  2118. </descr>
  2119. <seealso>
  2120. <link id="MilliSecondOfTheYear"/>
  2121. <link id="MilliSecondOfTheMonth"/>
  2122. <link id="MilliSecondOfTheDay"/>
  2123. <link id="MilliSecondOfTheHour"/>
  2124. <link id="MilliSecondOfTheMinute"/>
  2125. <link id="MilliSecondOfTheSecond"/>
  2126. <link id="DayOfTheWeek"/>
  2127. <link id="HourOfTheWeek"/>
  2128. <link id="MinuteOfTheWeek"/>
  2129. <link id="SecondOfTheWeek"/>
  2130. </seealso>
  2131. </element>
  2132. <!-- function result Visibility: default -->
  2133. <element name="MilliSecondOfTheWeek.Result">
  2134. <short>Number of milliseconds passed since the start of the week.</short>
  2135. </element>
  2136. <!-- argument Visibility: default -->
  2137. <element name="MilliSecondOfTheWeek.AValue">
  2138. <short>Moment in the week to calculate milliseconds from.</short>
  2139. </element>
  2140. <!-- function Visibility: default -->
  2141. <element name="HourOfTheDay">
  2142. <short>Calculate the hour of a given DateTime value</short>
  2143. <descr>
  2144. <p>
  2145. <var>HourOfTheDay</var> returns the number of hours that have passed since
  2146. the start of the day till the moment indicated by
  2147. <var>AValue</var>. This is a zero-based number, i.e.
  2148. 00:59:59 will return 0.
  2149. </p>
  2150. </descr>
  2151. <seealso>
  2152. <link id="HourOfTheYear"/>
  2153. <link id="HourOfTheMonth"/>
  2154. <link id="HourOfTheWeek"/>
  2155. <link id="MinuteOfTheDay"/>
  2156. <link id="SecondOfTheDay"/>
  2157. <link id="MilliSecondOfTheDay"/>
  2158. </seealso>
  2159. <example file="datutex/ex43"/>
  2160. </element>
  2161. <!-- function result Visibility: default -->
  2162. <element name="HourOfTheDay.Result">
  2163. <short>Hour part of <var>AValue</var>.</short>
  2164. </element>
  2165. <!-- argument Visibility: default -->
  2166. <element name="HourOfTheDay.AValue">
  2167. <short>DateTime to calculate the hour of.</short>
  2168. </element>
  2169. <!-- function Visibility: default -->
  2170. <element name="MinuteOfTheDay">
  2171. <short>Calculate the number of minutes elapsed since the start of the day</short>
  2172. <descr>
  2173. <p>
  2174. <var>MinuteOfTheDay</var> returns the number of minutes that have passed since
  2175. the start of the Day (00:00:00) till the moment indicated by
  2176. <var>AValue</var>. This is a zero-based number, i.e.
  2177. 00:00:59 will return 0.
  2178. </p>
  2179. <p>
  2180. For an example, see the <link id="HourOfTheDay"/> function.
  2181. </p>
  2182. </descr>
  2183. <seealso>
  2184. <link id="MinuteOfTheYear"/>
  2185. <link id="MinuteOfTheMonth"/>
  2186. <link id="MinuteOfTheWeek"/>
  2187. <link id="MinuteOfTheHour"/>
  2188. <link id="HourOfTheDay"/>
  2189. <link id="SecondOfTheDay"/>
  2190. <link id="MilliSecondOfTheDay"/>
  2191. </seealso>
  2192. </element>
  2193. <!-- function result Visibility: default -->
  2194. <element name="MinuteOfTheDay.Result">
  2195. <short>Number of minutes elapsed since the start of the day</short>
  2196. </element>
  2197. <!-- argument Visibility: default -->
  2198. <element name="MinuteOfTheDay.AValue">
  2199. <short>Moment in the day</short>
  2200. </element>
  2201. <!-- function Visibility: default -->
  2202. <element name="SecondOfTheDay">
  2203. <short>Calculate the number of seconds elapsed since the start of the day</short>
  2204. <descr>
  2205. <p>
  2206. <var>SecondOfTheDay</var> returns the number of seconds that have passed since
  2207. the start of the Day (00:00:00) till the moment indicated by
  2208. <var>AValue</var>. This is a zero-based number, i.e.
  2209. 00:00:00.999 return 0.
  2210. </p>
  2211. <p>
  2212. For an example, see the <link id="HourOfTheDay"/> function.
  2213. </p>
  2214. </descr>
  2215. <seealso>
  2216. <link id="SecondOfTheYear"/>
  2217. <link id="SecondOfTheMonth"/>
  2218. <link id="SecondOfTheWeek"/>
  2219. <link id="SecondOfTheHour"/>
  2220. <link id="SecondOfTheMinute"/>
  2221. <link id="HourOfTheDay"/>
  2222. <link id="MinuteOfTheDay"/>
  2223. <link id="MilliSecondOfTheDay"/>
  2224. </seealso>
  2225. </element>
  2226. <!-- function result Visibility: default -->
  2227. <element name="SecondOfTheDay.Result">
  2228. <short>Number of seconds elapsed since the start of the day</short>
  2229. </element>
  2230. <!-- argument Visibility: default -->
  2231. <element name="SecondOfTheDay.AValue">
  2232. <short>Moment in the day</short>
  2233. </element>
  2234. <!-- function Visibility: default -->
  2235. <element name="MilliSecondOfTheDay">
  2236. <short>Calculate the number of milliseconds elapsed since the start of the day</short>
  2237. <descr>
  2238. <p>
  2239. <var>MilliSecondOfTheDay</var> returns the number of milliseconds that have passed since
  2240. the start of the Day (00:00:00.000) till the moment indicated by
  2241. <var>AValue</var>. This is a zero-based number, i.e.
  2242. 00:00:00.000 will return 0.
  2243. </p>
  2244. <p>
  2245. For an example, see the <link id="HourOfTheDay"/> function.
  2246. </p>
  2247. </descr>
  2248. <seealso>
  2249. <link id="MilliSecondOfTheYear"/>
  2250. <link id="MilliSecondOfTheMonth"/>
  2251. <link id="MilliSecondOfTheWeek"/>
  2252. <link id="MilliSecondOfTheHour"/>
  2253. <link id="MilliSecondOfTheMinute"/>
  2254. <link id="MilliSecondOfTheSecond"/>
  2255. <link id="HourOfTheDay"/>
  2256. <link id="MinuteOfTheDay"/>
  2257. <link id="SecondOfTheDay"/>
  2258. </seealso>
  2259. </element>
  2260. <!-- function result Visibility: default -->
  2261. <element name="MilliSecondOfTheDay.Result">
  2262. <short>Number of milliseconds elapsed since the start of the day</short>
  2263. </element>
  2264. <!-- argument Visibility: default -->
  2265. <element name="MilliSecondOfTheDay.AValue">
  2266. <short>Moment in the day</short>
  2267. </element>
  2268. <!-- function Visibility: default -->
  2269. <element name="MinuteOfTheHour">
  2270. <short>Calculate the number of minutes elapsed since the start of the hour</short>
  2271. <descr>
  2272. <p>
  2273. <var>MinuteOfTheHour</var> returns the number of minutes that have passed since
  2274. the start of the Hour (HH:00:00) till the moment indicated by
  2275. <var>AValue</var>. This is a zero-based number, i.e.
  2276. HH:00:59 will return 0.
  2277. </p>
  2278. </descr>
  2279. <seealso>
  2280. <link id="MinuteOfTheYear"/>
  2281. <link id="MinuteOfTheMonth"/>
  2282. <link id="MinuteOfTheWeek"/>
  2283. <link id="MinuteOfTheDay"/>
  2284. <link id="SecondOfTheHour"/>
  2285. <link id="MilliSecondOfTheHour"/>
  2286. </seealso>
  2287. <example file="datutex/ex44"/>
  2288. </element>
  2289. <!-- function result Visibility: default -->
  2290. <element name="MinuteOfTheHour.Result">
  2291. <short>Number of minutes elapsed since the start of the hour</short>
  2292. </element>
  2293. <!-- argument Visibility: default -->
  2294. <element name="MinuteOfTheHour.AValue">
  2295. <short>Moment in the hour</short>
  2296. </element>
  2297. <!-- function Visibility: default -->
  2298. <element name="SecondOfTheHour">
  2299. <short>Calculate the number of seconds elapsed since the start of the hour</short>
  2300. <descr>
  2301. <p>
  2302. <var>SecondOfTheHour</var> returns the number of seconds that have passed since
  2303. the start of the Hour (HH:00:00) till the moment indicated by
  2304. <var>AValue</var>. This is a zero-based number, i.e.
  2305. HH:00:00.999 return 0.
  2306. </p>
  2307. <p>
  2308. For an example, see the <link id="MinuteOfTheHour"/> function.
  2309. </p>
  2310. </descr>
  2311. <seealso>
  2312. <link id="SecondOfTheYear"/>
  2313. <link id="SecondOfTheMonth"/>
  2314. <link id="SecondOfTheWeek"/>
  2315. <link id="SecondOfTheDay"/>
  2316. <link id="SecondOfTheMinute"/>
  2317. <link id="MinuteOfTheHour"/>
  2318. <link id="MilliSecondOfTheHour"/>
  2319. </seealso>
  2320. </element>
  2321. <!-- function result Visibility: default -->
  2322. <element name="SecondOfTheHour.Result">
  2323. <short>Number of seconds elapsed since the start of the hour</short>
  2324. </element>
  2325. <!-- argument Visibility: default -->
  2326. <element name="SecondOfTheHour.AValue">
  2327. <short>Moment in the hour</short>
  2328. </element>
  2329. <!-- function Visibility: default -->
  2330. <element name="MilliSecondOfTheHour">
  2331. <short>Calculate the number of milliseconds elapsed since the start of the hour</short>
  2332. <descr>
  2333. <p>
  2334. <var>MilliSecondOfTheHour</var> returns the number of milliseconds that have passed since
  2335. the start of the Hour (HH:00:00.000) till the moment indicated by
  2336. <var>AValue</var>. This is a zero-based number, i.e.
  2337. HH:00:00.000 will return 0.
  2338. </p>
  2339. <p>
  2340. For an example, see the <link id="MinuteOfTheHour"/> function.
  2341. </p>
  2342. </descr>
  2343. <seealso>
  2344. <link id="MilliSecondOfTheYear"/>
  2345. <link id="MilliSecondOfTheMonth"/>
  2346. <link id="MilliSecondOfTheWeek"/>
  2347. <link id="MilliSecondOfTheDay"/>
  2348. <link id="MilliSecondOfTheMinute"/>
  2349. <link id="MilliSecondOfTheSecond"/>
  2350. <link id="MinuteOfTheHour"/>
  2351. <link id="SecondOfTheHour"/>
  2352. </seealso>
  2353. </element>
  2354. <!-- function result Visibility: default -->
  2355. <element name="MilliSecondOfTheHour.Result">
  2356. <short>Number of milliseconds elapsed since the start of the hour</short>
  2357. </element>
  2358. <!-- argument Visibility: default -->
  2359. <element name="MilliSecondOfTheHour.AValue">
  2360. <short>Moment in the hour</short>
  2361. </element>
  2362. <!-- function Visibility: default -->
  2363. <element name="SecondOfTheMinute">
  2364. <short>Calculate the number of seconds elapsed since the start of the minute</short>
  2365. <descr>
  2366. <p>
  2367. <var>SecondOfTheMinute</var> returns the number of seconds that have passed since
  2368. the start of the minute (HH:MM:00) till the moment indicated by
  2369. <var>AValue</var>. This is a zero-based number, i.e.
  2370. HH:MM:00.999 return 0.
  2371. </p>
  2372. </descr>
  2373. <seealso>
  2374. <link id="SecondOfTheYear"/>
  2375. <link id="SecondOfTheMonth"/>
  2376. <link id="SecondOfTheWeek"/>
  2377. <link id="SecondOfTheDay"/>
  2378. <link id="SecondOfTheHour"/>
  2379. <link id="MilliSecondOfTheMinute"/>
  2380. </seealso>
  2381. <example file="datutex/ex45"/>
  2382. </element>
  2383. <!-- function result Visibility: default -->
  2384. <element name="SecondOfTheMinute.Result">
  2385. <short>Number of seconds elapsed since the start of the minute</short>
  2386. </element>
  2387. <!-- argument Visibility: default -->
  2388. <element name="SecondOfTheMinute.AValue">
  2389. <short>Moment in the minute</short>
  2390. </element>
  2391. <!-- function Visibility: default -->
  2392. <element name="MilliSecondOfTheMinute">
  2393. <short>Calculate the number of milliseconds elapsed since the start of the minute</short>
  2394. <descr>
  2395. <p>
  2396. <var>MilliSecondOfTheMinute</var> returns the number of milliseconds that have passed since
  2397. the start of the Minute (HH:MM:00.000) till the moment indicated by
  2398. <var>AValue</var>. This is a zero-based number, i.e.
  2399. HH:MM:00.000 will return 0.
  2400. </p>
  2401. <p>
  2402. For an example, see the <link id="SecondOfTheMinute"/> function.
  2403. </p>
  2404. </descr>
  2405. <seealso>
  2406. <link id="MilliSecondOfTheYear"/>
  2407. <link id="MilliSecondOfTheMonth"/>
  2408. <link id="MilliSecondOfTheWeek"/>
  2409. <link id="MilliSecondOfTheDay"/>
  2410. <link id="MilliSecondOfTheHour"/>
  2411. <link id="MilliSecondOfTheMinute"/>
  2412. <link id="MilliSecondOfTheSecond"/>
  2413. <link id="SecondOfTheMinute"/>
  2414. </seealso>
  2415. </element>
  2416. <!-- function result Visibility: default -->
  2417. <element name="MilliSecondOfTheMinute.Result">
  2418. <short>Number of milliseconds elapsed since the start of the minute</short>
  2419. </element>
  2420. <!-- argument Visibility: default -->
  2421. <element name="MilliSecondOfTheMinute.AValue">
  2422. <short>Moment in the minute</short>
  2423. </element>
  2424. <!-- function Visibility: default -->
  2425. <element name="MilliSecondOfTheSecond">
  2426. <short>Calculate the number of milliseconds elapsed since the start of the second</short>
  2427. <descr>
  2428. <p>
  2429. <var>MilliSecondOfTheSecond</var> returns the number of milliseconds that have passed since
  2430. the start of the second (HH:MM:SS.000) till the moment indicated by
  2431. <var>AValue</var>. This is a zero-based number, i.e.
  2432. HH:MM:SS.000 will return 0.
  2433. </p>
  2434. </descr>
  2435. <seealso>
  2436. <link id="MilliSecondOfTheYear"/>
  2437. <link id="MilliSecondOfTheMonth"/>
  2438. <link id="MilliSecondOfTheWeek"/>
  2439. <link id="MilliSecondOfTheDay"/>
  2440. <link id="MilliSecondOfTheHour"/>
  2441. <link id="MilliSecondOfTheMinute"/>
  2442. <link id="SecondOfTheMinute"/>
  2443. </seealso>
  2444. <example file="datutex/ex46"/>
  2445. </element>
  2446. <!-- function result Visibility: default -->
  2447. <element name="MilliSecondOfTheSecond.Result">
  2448. <short>Number of milliseconds elapsed since the start of the second</short>
  2449. </element>
  2450. <!-- argument Visibility: default -->
  2451. <element name="MilliSecondOfTheSecond.AValue">
  2452. <short>Moment in the second</short>
  2453. </element>
  2454. <!-- function Visibility: default -->
  2455. <element name="WithinPastYears">
  2456. <short>Check whether two datetimes are only a number of years apart</short>
  2457. <descr>
  2458. <p>
  2459. <var>WithinPastYears</var> compares the timestamps <var>ANow</var> and <var>AThen</var>
  2460. and returns <var>True</var> if the difference between them is at most
  2461. <var>AYears</var> years apart, or <var>False</var> if they are further
  2462. apart.
  2463. </p>
  2464. <remark>
  2465. Since this function uses the <link id="YearsBetween"/> function to calculate
  2466. the difference in years, this means that fractional years do not count, and
  2467. the fractional part is simply dropped, so for two dates actually 2 and a half
  2468. years apart, the result will also be <var>True</var>
  2469. </remark>
  2470. </descr>
  2471. <seealso>
  2472. <link id="WithinPastMonths"/>
  2473. <link id="WithinPastWeeks"/>
  2474. <link id="WithinPastDays"/>
  2475. <link id="WithinPastHours"/>
  2476. <link id="WithinPastMinutes"/>
  2477. <link id="WithinPastSeconds"/>
  2478. <link id="WithinPastMilliSeconds"/>
  2479. </seealso>
  2480. <example file="datutex/ex47"/>
  2481. </element>
  2482. <!-- function result Visibility: default -->
  2483. <element name="WithinPastYears.Result">
  2484. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AYears</var> apart,
  2485. <var>false</var> otherwise</short>
  2486. </element>
  2487. <!-- argument Visibility: default -->
  2488. <element name="WithinPastYears.ANow">
  2489. <short>First moment in time</short>
  2490. </element>
  2491. <!-- argument Visibility: default -->
  2492. <element name="WithinPastYears.AThen">
  2493. <short>Second moment in time</short>
  2494. </element>
  2495. <!-- argument Visibility: default -->
  2496. <element name="WithinPastYears.AYears">
  2497. <short>Number of years to check</short>
  2498. </element>
  2499. <!-- function Visibility: default -->
  2500. <element name="WithinPastMonths">
  2501. <short>Check whether two datetimes are only a number of months apart</short>
  2502. <descr>
  2503. <p>
  2504. <var>WithinPastMonths</var> compares the timestamps <var>ANow</var> and <var>AThen</var>
  2505. and returns <var>True</var> if the difference between them is at most
  2506. <var>AMonths</var> months apart, or <var>False</var> if they are further
  2507. apart.
  2508. </p>
  2509. <remark>
  2510. Since this function uses the <link id="MonthsBetween"/> function to calculate
  2511. the difference in Months, this means that fractional months do not count, and
  2512. the fractional part is simply dropped, so for two dates actually 2 and a half
  2513. months apart, the result will also be <var>True</var>
  2514. </remark>
  2515. </descr>
  2516. <seealso>
  2517. <link id="WithinPastYears"/>
  2518. <link id="WithinPastWeeks"/>
  2519. <link id="WithinPastDays"/>
  2520. <link id="WithinPastHours"/>
  2521. <link id="WithinPastMinutes"/>
  2522. <link id="WithinPastSeconds"/>
  2523. <link id="WithinPastMilliSeconds"/>
  2524. </seealso>
  2525. <example file="datutex/ex48"/>
  2526. </element>
  2527. <!-- function result Visibility: default -->
  2528. <element name="WithinPastMonths.Result">
  2529. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AMonths</var> apart,
  2530. <var>false</var> otherwise</short>
  2531. </element>
  2532. <!-- argument Visibility: default -->
  2533. <element name="WithinPastMonths.ANow">
  2534. <short>First moment in time</short>
  2535. </element>
  2536. <!-- argument Visibility: default -->
  2537. <element name="WithinPastMonths.AThen">
  2538. <short>Second moment in time</short>
  2539. </element>
  2540. <!-- argument Visibility: default -->
  2541. <element name="WithinPastMonths.AMonths">
  2542. <short>Number of months to check</short>
  2543. </element>
  2544. <!-- function Visibility: default -->
  2545. <element name="WithinPastWeeks">
  2546. <short>Check whether two datetimes are only a number of weeks apart</short>
  2547. <descr>
  2548. <p>
  2549. <var>WithinPastWeeks</var> compares the timestamps <var>ANow</var> and <var>AThen</var>
  2550. and returns <var>True</var> if the difference between them is at most
  2551. <var>AWeeks</var> weeks apart, or <var>False</var> if they are further
  2552. apart.
  2553. </p>
  2554. <remark>
  2555. Since this function uses the <link id="WeeksBetween"/> function to calculate
  2556. the difference in Weeks, this means that fractional Weeks do not count, and
  2557. the fractional part is simply dropped, so for two dates actually 2 and a half
  2558. weeks apart, the result will also be <var>True</var>
  2559. </remark>
  2560. </descr>
  2561. <seealso>
  2562. <link id="WithinPastYears"/>
  2563. <link id="WithinPastMonths"/>
  2564. <link id="WithinPastDays"/>
  2565. <link id="WithinPastHours"/>
  2566. <link id="WithinPastMinutes"/>
  2567. <link id="WithinPastSeconds"/>
  2568. <link id="WithinPastMilliSeconds"/>
  2569. </seealso>
  2570. <example file="datutex/ex49"/>
  2571. </element>
  2572. <!-- function result Visibility: default -->
  2573. <element name="WithinPastWeeks.Result">
  2574. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AWeeks</var> apart,
  2575. <var>false</var> otherwise</short>
  2576. </element>
  2577. <!-- argument Visibility: default -->
  2578. <element name="WithinPastWeeks.ANow">
  2579. <short>First moment in time</short>
  2580. </element>
  2581. <!-- argument Visibility: default -->
  2582. <element name="WithinPastWeeks.AThen">
  2583. <short>Second moment in time</short>
  2584. </element>
  2585. <!-- argument Visibility: default -->
  2586. <element name="WithinPastWeeks.AWeeks">
  2587. <short>Number of weeks to check</short>
  2588. </element>
  2589. <!-- function Visibility: default -->
  2590. <element name="WithinPastDays">
  2591. <short>Check whether two datetimes are only a number of days apart</short>
  2592. <descr>
  2593. <p>
  2594. <var>WithinPastDays</var> compares the timestamps <var>ANow</var> and <var>AThen</var>
  2595. and returns <var>True</var> if the difference between them is at most
  2596. <var>ADays</var> days apart, or <var>False</var> if they are further
  2597. apart.
  2598. </p>
  2599. <remark>
  2600. Since this function uses the <link id="DaysBetween"/> function to calculate
  2601. the difference in days, this means that fractional days do not count, and
  2602. the fractional part is simply dropped, so for two dates actually 2 and a half
  2603. days apart, the result will also be <var>True</var>
  2604. </remark>
  2605. </descr>
  2606. <seealso>
  2607. <link id="WithinPastYears"/>
  2608. <link id="WithinPastMonths"/>
  2609. <link id="WithinPastWeeks"/>
  2610. <link id="WithinPastHours"/>
  2611. <link id="WithinPastMinutes"/>
  2612. <link id="WithinPastSeconds"/>
  2613. <link id="WithinPastMilliSeconds"/>
  2614. </seealso>
  2615. <example file="datutex/ex50"/>
  2616. </element>
  2617. <!-- function result Visibility: default -->
  2618. <element name="WithinPastDays.Result">
  2619. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>ADays</var> apart,
  2620. <var>false</var> otherwise</short>
  2621. </element>
  2622. <!-- argument Visibility: default -->
  2623. <element name="WithinPastDays.ANow">
  2624. <short>First moment in time</short>
  2625. </element>
  2626. <!-- argument Visibility: default -->
  2627. <element name="WithinPastDays.AThen">
  2628. <short>Second moment in time</short>
  2629. </element>
  2630. <!-- argument Visibility: default -->
  2631. <element name="WithinPastDays.ADays">
  2632. <short>Number of days to check</short>
  2633. </element>
  2634. <!-- function Visibility: default -->
  2635. <element name="WithinPastHours">
  2636. <short>Check whether two datetimes are only a number of hours apart</short>
  2637. <descr>
  2638. <p>
  2639. <var>WithinPastHours</var> compares the timestamps <var>ANow</var> and <var>AThen</var>
  2640. and returns <var>True</var> if the difference between them is at most
  2641. <var>AHours</var> hours apart, or <var>False</var> if they are further
  2642. apart.
  2643. </p>
  2644. <remark>
  2645. Since this function uses the <link id="HoursBetween"/> function to calculate
  2646. the difference in Hours, this means that fractional hours do not count, and
  2647. the fractional part is simply dropped, so for two dates actually 2 and a half
  2648. hours apart, the result will also be <var>True</var>
  2649. </remark>
  2650. </descr>
  2651. <seealso>
  2652. <link id="WithinPastYears"/>
  2653. <link id="WithinPastMonths"/>
  2654. <link id="WithinPastWeeks"/>
  2655. <link id="WithinPastDays"/>
  2656. <link id="WithinPastMinutes"/>
  2657. <link id="WithinPastSeconds"/>
  2658. <link id="WithinPastMilliSeconds"/>
  2659. </seealso>
  2660. <example file="datutex/ex51"/>
  2661. </element>
  2662. <!-- function result Visibility: default -->
  2663. <element name="WithinPastHours.Result">
  2664. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AHours</var> apart,
  2665. <var>false</var> otherwise</short>
  2666. </element>
  2667. <!-- argument Visibility: default -->
  2668. <element name="WithinPastHours.ANow">
  2669. <short>First moment in time</short>
  2670. </element>
  2671. <!-- argument Visibility: default -->
  2672. <element name="WithinPastHours.AThen">
  2673. <short>Second moment in time</short>
  2674. </element>
  2675. <!-- argument Visibility: default -->
  2676. <element name="WithinPastHours.AHours">
  2677. <short>Number of hours to check</short>
  2678. </element>
  2679. <!-- function Visibility: default -->
  2680. <element name="WithinPastMinutes">
  2681. <short>Check whether two datetimes are only a number of minutes apart</short>
  2682. <descr>
  2683. <p>
  2684. <var>WithinPastMinutes</var> compares the timestamps <var>ANow</var> and <var>AThen</var>
  2685. and returns <var>True</var> if the difference between them is at most
  2686. <var>AMinutes</var> minutes apart, or <var>False</var> if they are further
  2687. apart.
  2688. </p>
  2689. <remark>
  2690. Since this function uses the <link id="MinutesBetween"/> function to calculate
  2691. the difference in Minutes, this means that fractional minutes do not count, and
  2692. the fractional part is simply dropped, so for two dates actually 2 and a half
  2693. minutes apart, the result will also be <var>True</var>
  2694. </remark>
  2695. </descr>
  2696. <seealso>
  2697. <link id="WithinPastYears"/>
  2698. <link id="WithinPastMonths"/>
  2699. <link id="WithinPastWeeks"/>
  2700. <link id="WithinPastDays"/>
  2701. <link id="WithinPastHours"/>
  2702. <link id="WithinPastSeconds"/>
  2703. <link id="WithinPastMilliSeconds"/>
  2704. </seealso>
  2705. <example file="datutex/ex52"/>
  2706. </element>
  2707. <!-- function result Visibility: default -->
  2708. <element name="WithinPastMinutes.Result">
  2709. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AMinutes</var> apart,
  2710. <var>false</var> otherwise</short>
  2711. </element>
  2712. <!-- argument Visibility: default -->
  2713. <element name="WithinPastMinutes.ANow">
  2714. <short>First moment in time</short>
  2715. </element>
  2716. <!-- argument Visibility: default -->
  2717. <element name="WithinPastMinutes.AThen">
  2718. <short>Second moment in time</short>
  2719. </element>
  2720. <!-- argument Visibility: default -->
  2721. <element name="WithinPastMinutes.AMinutes">
  2722. <short>Number of minutes to check</short>
  2723. </element>
  2724. <!-- function Visibility: default -->
  2725. <element name="WithinPastSeconds">
  2726. <short>Check whether two datetimes are only a number of seconds apart</short>
  2727. <descr>
  2728. <p>
  2729. <var>WithinPastSeconds</var> compares the timestamps <var>ANow</var> and <var>AThen</var>
  2730. and returns <var>True</var> if the difference between them is at most
  2731. <var>ASeconds</var> seconds apart, or <var>False</var> if they are further
  2732. apart.
  2733. </p>
  2734. <remark>
  2735. Since this function uses the <link id="SecondsBetween"/> function to calculate
  2736. the difference in seconds, this means that fractional seconds do not count, and
  2737. the fractional part is simply dropped, so for two dates actually 2 and a half
  2738. seconds apart, the result will also be <var>True</var>
  2739. </remark>
  2740. </descr>
  2741. <seealso>
  2742. <link id="WithinPastYears"/>
  2743. <link id="WithinPastMonths"/>
  2744. <link id="WithinPastWeeks"/>
  2745. <link id="WithinPastDays"/>
  2746. <link id="WithinPastHours"/>
  2747. <link id="WithinPastMinutes"/>
  2748. <link id="WithinPastMilliSeconds"/>
  2749. </seealso>
  2750. <example file="datutex/ex53"/>
  2751. </element>
  2752. <!-- function result Visibility: default -->
  2753. <element name="WithinPastSeconds.Result">
  2754. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>ASeconds</var> apart,
  2755. <var>false</var> otherwise</short>
  2756. </element>
  2757. <!-- argument Visibility: default -->
  2758. <element name="WithinPastSeconds.ANow">
  2759. <short>First moment in time</short>
  2760. </element>
  2761. <!-- argument Visibility: default -->
  2762. <element name="WithinPastSeconds.AThen">
  2763. <short>Second moment in time</short>
  2764. </element>
  2765. <!-- argument Visibility: default -->
  2766. <element name="WithinPastSeconds.ASeconds">
  2767. <short>Number of seconds to check</short>
  2768. </element>
  2769. <!-- function Visibility: default -->
  2770. <element name="WithinPastMilliSeconds">
  2771. <short>Check whether two datetimes are only a number of milliseconds apart</short>
  2772. <descr>
  2773. <p>
  2774. <var>WithinPastMilliSeconds</var> compares the timestamps <var>ANow</var> and <var>AThen</var>
  2775. and returns <var>True</var> if the difference between them is at most
  2776. <var>AMilliSeconds</var> milliseconds apart, or <var>False</var> if they are further
  2777. apart.
  2778. </p>
  2779. <remark>
  2780. Since this function uses the <link id="MilliSecondsBetween"/> function to calculate
  2781. the difference in milliseconds, this means that fractional milliseconds do not count, and
  2782. the fractional part is simply dropped, so for two dates actually 2 and a half
  2783. milliseconds apart, the result will also be <var>True</var>
  2784. </remark>
  2785. </descr>
  2786. <seealso>
  2787. <link id="WithinPastYears"/>
  2788. <link id="WithinPastMonths"/>
  2789. <link id="WithinPastWeeks"/>
  2790. <link id="WithinPastDays"/>
  2791. <link id="WithinPastHours"/>
  2792. <link id="WithinPastMinutes"/>
  2793. <link id="WithinPastSeconds"/>
  2794. </seealso>
  2795. <example file="datutex/ex54"/>
  2796. </element>
  2797. <!-- function result Visibility: default -->
  2798. <element name="WithinPastMilliSeconds.Result">
  2799. <short><var>True</var> if <var>ANow</var> and <var>Athen</var> are only <var>AMilliSeconds</var> apart,
  2800. <var>false</var> otherwise</short>
  2801. </element>
  2802. <!-- argument Visibility: default -->
  2803. <element name="WithinPastMilliSeconds.ANow">
  2804. <short>First moment in time</short>
  2805. </element>
  2806. <!-- argument Visibility: default -->
  2807. <element name="WithinPastMilliSeconds.AThen">
  2808. <short>Second moment in time</short>
  2809. </element>
  2810. <!-- argument Visibility: default -->
  2811. <element name="WithinPastMilliSeconds.AMilliSeconds">
  2812. <short>Number of milliseconds to check</short>
  2813. </element>
  2814. <!-- function Visibility: default -->
  2815. <element name="YearsBetween">
  2816. <short>Calculate the number of whole years between two DateTime values</short>
  2817. <descr>
  2818. <var>YearsBetween</var> returns the number of whole years between
  2819. <var>ANow</var> and <var>AThen</var>. This number is an approximation,
  2820. based on an average number of days of 365.25 per year (average over 4
  2821. years). This means the fractional part of a year is dropped.
  2822. </descr>
  2823. <seealso>
  2824. <link id="MonthsBetween"/>
  2825. <link id="WeeksBetween"/>
  2826. <link id="DaysBetween"/>
  2827. <link id="HoursBetween"/>
  2828. <link id="MinutesBetween"/>
  2829. <link id="SecondsBetween"/>
  2830. <link id="MilliSecondsBetween"/>
  2831. <link id="YearSpan"/>
  2832. </seealso>
  2833. <example file="datutex/ex55"/>
  2834. </element>
  2835. <!-- function result Visibility: default -->
  2836. <element name="YearsBetween.Result">
  2837. <short>Number of whole years between <var>ANow</var> and <var>AThen</var>.</short>
  2838. </element>
  2839. <!-- argument Visibility: default -->
  2840. <element name="YearsBetween.ANow">
  2841. <short>First moment in time</short>
  2842. </element>
  2843. <!-- argument Visibility: default -->
  2844. <element name="YearsBetween.AThen">
  2845. <short>Second moment in time</short>
  2846. </element>
  2847. <!-- function Visibility: default -->
  2848. <element name="MonthsBetween">
  2849. <short>Calculate the number of whole months between two DateTime values</short>
  2850. <descr>
  2851. <var>MonthsBetween</var> returns the number of whole months between
  2852. <var>ANow</var> and <var>AThen</var>. This number is an approximation,
  2853. based on an average number of days of 30.4375 per month (average over 4
  2854. years). This means the fractional part of a month is dropped.
  2855. </descr>
  2856. <seealso>
  2857. <link id="YearsBetween"/>
  2858. <link id="WeeksBetween"/>
  2859. <link id="DaysBetween"/>
  2860. <link id="HoursBetween"/>
  2861. <link id="MinutesBetween"/>
  2862. <link id="SecondsBetween"/>
  2863. <link id="MilliSecondsBetween"/>
  2864. </seealso>
  2865. <example file="datutex/ex56"/>
  2866. </element>
  2867. <!-- function result Visibility: default -->
  2868. <element name="MonthsBetween.Result">
  2869. <short>Number of whole months between <var>ANow</var> and <var>AThen</var>.</short>
  2870. </element>
  2871. <!-- argument Visibility: default -->
  2872. <element name="MonthsBetween.ANow">
  2873. <short>First moment in time</short>
  2874. </element>
  2875. <!-- argument Visibility: default -->
  2876. <element name="MonthsBetween.AThen">
  2877. <short>Second moment in time</short>
  2878. </element>
  2879. <!-- function Visibility: default -->
  2880. <element name="WeeksBetween">
  2881. <short>Calculate the number of whole weeks between two DateTime values</short>
  2882. <descr>
  2883. <var>WeeksBetween</var> returns the number of whole weeks between
  2884. <var>ANow</var> and <var>AThen</var>.
  2885. This means the fractional part of a Week is dropped.
  2886. </descr>
  2887. <seealso>
  2888. <link id="YearsBetween"/>
  2889. <link id="MonthsBetween"/>
  2890. <link id="DaysBetween"/>
  2891. <link id="HoursBetween"/>
  2892. <link id="MinutesBetween"/>
  2893. <link id="SecondsBetween"/>
  2894. <link id="MilliSecondsBetween"/>
  2895. </seealso>
  2896. <example file="datutex/ex57"/>
  2897. </element>
  2898. <!-- function result Visibility: default -->
  2899. <element name="WeeksBetween.Result">
  2900. <short>Number of whole weeks between <var>ANow</var> and <var>AThen</var>.</short>
  2901. </element>
  2902. <!-- argument Visibility: default -->
  2903. <element name="WeeksBetween.ANow">
  2904. <short>First moment in time</short>
  2905. </element>
  2906. <!-- argument Visibility: default -->
  2907. <element name="WeeksBetween.AThen">
  2908. <short>Second moment in time</short>
  2909. </element>
  2910. <!-- function Visibility: default -->
  2911. <element name="DaysBetween">
  2912. <short>Number of whole days between two DateTime values.</short>
  2913. <descr>
  2914. <var>DaysBetween</var> returns the number of whole days between
  2915. <var>ANow</var> and <var>AThen</var>.
  2916. This means the fractional part of a day (hours, minutes, etc.) is dropped.
  2917. </descr>
  2918. <seealso>
  2919. <link id="YearsBetween"/>
  2920. <link id="MonthsBetween"/>
  2921. <link id="WeeksBetween"/>
  2922. <link id="HoursBetween"/>
  2923. <link id="MinutesBetween"/>
  2924. <link id="SecondsBetween"/>
  2925. <link id="MilliSecondsBetween"/>
  2926. </seealso>
  2927. <example file="datutex/ex58"/>
  2928. </element>
  2929. <!-- function result Visibility: default -->
  2930. <element name="DaysBetween.Result">
  2931. <short>Number of whole days between <var>ANow</var> and <var>AThen</var>.</short>
  2932. </element>
  2933. <!-- argument Visibility: default -->
  2934. <element name="DaysBetween.ANow">
  2935. <short>First date</short>
  2936. </element>
  2937. <!-- argument Visibility: default -->
  2938. <element name="DaysBetween.AThen">
  2939. <short>Second date</short>
  2940. </element>
  2941. <!-- function Visibility: default -->
  2942. <element name="HoursBetween">
  2943. <short>Calculate the number of whole hours between two DateTime values.</short>
  2944. <descr>
  2945. <var>HoursBetween</var> returns the number of whole hours between
  2946. <var>ANow</var> and <var>AThen</var>.
  2947. This means the fractional part of an hour (minutes,seconds etc.) is dropped.
  2948. </descr>
  2949. <seealso>
  2950. <link id="YearsBetween"/>
  2951. <link id="MonthsBetween"/>
  2952. <link id="WeeksBetween"/>
  2953. <link id="DaysBetween"/>
  2954. <link id="MinutesBetween"/>
  2955. <link id="SecondsBetween"/>
  2956. <link id="MilliSecondsBetween"/>
  2957. </seealso>
  2958. <example file="datutex/ex59"/>
  2959. </element>
  2960. <!-- function result Visibility: default -->
  2961. <element name="HoursBetween.Result">
  2962. <short>Number of hours between <var>ANow</var> and <var>AThen</var></short>
  2963. </element>
  2964. <!-- argument Visibility: default -->
  2965. <element name="HoursBetween.ANow">
  2966. <short>First DateTime value</short>
  2967. </element>
  2968. <!-- argument Visibility: default -->
  2969. <element name="HoursBetween.AThen">
  2970. <short>Second DateTime value</short>
  2971. </element>
  2972. <!-- function Visibility: default -->
  2973. <element name="MinutesBetween">
  2974. <short>Calculate the number of whole minutes between two DateTime values.</short>
  2975. <descr>
  2976. <var>MinutesBetween</var> returns the number of whole minutes between
  2977. <var>ANow</var> and <var>AThen</var>.
  2978. This means the fractional part of a minute (seconds, milliseconds etc.) is dropped.
  2979. </descr>
  2980. <seealso>
  2981. <link id="YearsBetween"/>
  2982. <link id="MonthsBetween"/>
  2983. <link id="WeeksBetween"/>
  2984. <link id="DaysBetween"/>
  2985. <link id="HoursBetween"/>
  2986. <link id="SecondsBetween"/>
  2987. <link id="MilliSecondsBetween"/>
  2988. </seealso>
  2989. <example file="datutex/ex60"/>
  2990. </element>
  2991. <!-- function result Visibility: default -->
  2992. <element name="MinutesBetween.Result">
  2993. <short>Number of minutes between <var>ANow</var> and <var>AThen</var></short>
  2994. </element>
  2995. <!-- argument Visibility: default -->
  2996. <element name="MinutesBetween.ANow">
  2997. <short>First moment in time</short>
  2998. </element>
  2999. <!-- argument Visibility: default -->
  3000. <element name="MinutesBetween.AThen">
  3001. <short>Second moment in time</short>
  3002. </element>
  3003. <!-- function Visibility: default -->
  3004. <element name="SecondsBetween">
  3005. <short>Calculate the number of whole seconds between two DateTime values.</short>
  3006. <descr>
  3007. <var>SecondsBetween</var> returns the number of whole seconds between
  3008. <var>ANow</var> and <var>AThen</var>.
  3009. This means the fractional part of a second (milliseconds etc.) is dropped.
  3010. </descr>
  3011. <seealso>
  3012. <link id="YearsBetween"/>
  3013. <link id="MonthsBetween"/>
  3014. <link id="WeeksBetween"/>
  3015. <link id="DaysBetween"/>
  3016. <link id="HoursBetween"/>
  3017. <link id="MinutesBetween"/>
  3018. <link id="MilliSecondsBetween"/>
  3019. </seealso>
  3020. <example file="datutex/ex61"/>
  3021. </element>
  3022. <!-- function result Visibility: default -->
  3023. <element name="SecondsBetween.Result">
  3024. <short>Number of seconds between <var>ANow</var> and <var>AThen</var></short>
  3025. </element>
  3026. <!-- argument Visibility: default -->
  3027. <element name="SecondsBetween.ANow">
  3028. <short>First moment in time</short>
  3029. </element>
  3030. <!-- argument Visibility: default -->
  3031. <element name="SecondsBetween.AThen">
  3032. <short>Second moment in time</short>
  3033. </element>
  3034. <!-- function Visibility: default -->
  3035. <element name="MilliSecondsBetween">
  3036. <short>Calculate the number of whole milliseconds between two DateTime values.</short>
  3037. <descr>
  3038. <var>MillisSecondsBetween</var> returns the number of whole milliseconds between
  3039. <var>ANow</var> and <var>AThen</var>.
  3040. This means a fractional part of a millisecond is dropped.
  3041. </descr>
  3042. <seealso>
  3043. <link id="YearsBetween"/>
  3044. <link id="MonthsBetween"/>
  3045. <link id="WeeksBetween"/>
  3046. <link id="DaysBetween"/>
  3047. <link id="HoursBetween"/>
  3048. <link id="MinutesBetween"/>
  3049. <link id="SecondsBetween"/>
  3050. </seealso>
  3051. <example file="datutex/ex62"/>
  3052. </element>
  3053. <!-- function result Visibility: default -->
  3054. <element name="MilliSecondsBetween.Result">
  3055. <short>Number of milliseconds between <var>ANow</var> and <var>AThen</var></short>
  3056. </element>
  3057. <!-- argument Visibility: default -->
  3058. <element name="MilliSecondsBetween.ANow">
  3059. <short>First moment in time</short>
  3060. </element>
  3061. <!-- argument Visibility: default -->
  3062. <element name="MilliSecondsBetween.AThen">
  3063. <short>Second moment in time</short>
  3064. </element>
  3065. <!-- function Visibility: default -->
  3066. <element name="YearSpan">
  3067. <short>Calculate the approximate number of years between two DateTime values.</short>
  3068. <descr>
  3069. <var>YearSpan</var> returns the number of years between <var>ANow</var> and
  3070. <var>AThen</var>, including any fractional parts of a year. This number is an approximation,
  3071. based on an average number of days of 365.25 per year (average over 4
  3072. years).
  3073. </descr>
  3074. <seealso>
  3075. <link id="MonthSpan"/>
  3076. <link id="WeekSpan"/>
  3077. <link id="DaySpan"/>
  3078. <link id="HourSpan"/>
  3079. <link id="MinuteSpan"/>
  3080. <link id="SecondSpan"/>
  3081. <link id="MilliSecondSpan"/>
  3082. <link id="YearsBetween"/>
  3083. </seealso>
  3084. <example file="datutex/ex63"/>
  3085. </element>
  3086. <!-- function result Visibility: default -->
  3087. <element name="YearSpan.Result">
  3088. <short>Number (fractions included) of years between <var>ANow</var> and <var>AThen</var></short>
  3089. </element>
  3090. <!-- argument Visibility: default -->
  3091. <element name="YearSpan.ANow">
  3092. <short>First moment in time</short>
  3093. </element>
  3094. <!-- argument Visibility: default -->
  3095. <element name="YearSpan.AThen">
  3096. <short>Second moment in time</short>
  3097. </element>
  3098. <!-- function Visibility: default -->
  3099. <element name="MonthSpan">
  3100. <short>Calculate the approximate number of months between two DateTime values.</short>
  3101. <descr>
  3102. <var>MonthSpan</var> returns the number of month between <var>ANow</var> and
  3103. <var>AThen</var>, including any fractional parts of a month. This number is an approximation,
  3104. based on an average number of days of 30.4375 per month (average over 4
  3105. years).
  3106. </descr>
  3107. <seealso>
  3108. <link id="YearSpan"/>
  3109. <link id="WeekSpan"/>
  3110. <link id="DaySpan"/>
  3111. <link id="HourSpan"/>
  3112. <link id="MinuteSpan"/>
  3113. <link id="SecondSpan"/>
  3114. <link id="MilliSecondSpan"/>
  3115. <link id="MonthsBetween"/>
  3116. </seealso>
  3117. <example file="datutex/ex64"/>
  3118. </element>
  3119. <!-- function result Visibility: default -->
  3120. <element name="MonthSpan.Result">
  3121. <short>Number (fractions included) of months between <var>ANow</var> and <var>AThen</var></short>
  3122. </element>
  3123. <!-- argument Visibility: default -->
  3124. <element name="MonthSpan.ANow">
  3125. <short>First moment in time</short>
  3126. </element>
  3127. <!-- argument Visibility: default -->
  3128. <element name="MonthSpan.AThen">
  3129. <short>Second moment in time</short>
  3130. </element>
  3131. <!-- function Visibility: default -->
  3132. <element name="WeekSpan">
  3133. <short>Calculate the approximate number of weeks between two DateTime values.</short>
  3134. <descr>
  3135. <var>WeekSpan</var> returns the number of weeks between <var>ANow</var> and
  3136. <var>AThen</var>, including any fractional parts of a week.
  3137. </descr>
  3138. <seealso>
  3139. <link id="YearSpan"/>
  3140. <link id="MonthSpan"/>
  3141. <link id="DaySpan"/>
  3142. <link id="HourSpan"/>
  3143. <link id="MinuteSpan"/>
  3144. <link id="SecondSpan"/>
  3145. <link id="MilliSecondSpan"/>
  3146. <link id="WeeksBetween"/>
  3147. </seealso>
  3148. <example file="datutex/ex65"/>
  3149. </element>
  3150. <!-- function result Visibility: default -->
  3151. <element name="WeekSpan.Result">
  3152. <short>Number (fractions included) of weeks between <var>ANow</var> and <var>AThen</var></short>
  3153. </element>
  3154. <!-- argument Visibility: default -->
  3155. <element name="WeekSpan.ANow">
  3156. <short>First moment in time</short>
  3157. </element>
  3158. <!-- argument Visibility: default -->
  3159. <element name="WeekSpan.AThen">
  3160. <short>Second moment in time</short>
  3161. </element>
  3162. <!-- function Visibility: default -->
  3163. <element name="DaySpan">
  3164. <short>Calculate the approximate number of days between two DateTime values.</short>
  3165. <descr>
  3166. <var>DaySpan</var> returns the number of Days between <var>ANow</var> and
  3167. <var>AThen</var>, including any fractional parts of a Day.
  3168. </descr>
  3169. <seealso>
  3170. <link id="YearSpan"/>
  3171. <link id="MonthSpan"/>
  3172. <link id="WeekSpan"/>
  3173. <link id="HourSpan"/>
  3174. <link id="MinuteSpan"/>
  3175. <link id="SecondSpan"/>
  3176. <link id="MilliSecondSpan"/>
  3177. <link id="DaysBetween"/>
  3178. </seealso>
  3179. <example file="datutex/ex66"/>
  3180. </element>
  3181. <!-- function result Visibility: default -->
  3182. <element name="DaySpan.Result">
  3183. <short>Number (fractions included) of days between <var>ANow</var> and <var>AThen</var></short>
  3184. </element>
  3185. <!-- argument Visibility: default -->
  3186. <element name="DaySpan.ANow">
  3187. <short>First moment in time</short>
  3188. </element>
  3189. <!-- argument Visibility: default -->
  3190. <element name="DaySpan.AThen">
  3191. <short>Second moment in time</short>
  3192. </element>
  3193. <!-- function Visibility: default -->
  3194. <element name="HourSpan">
  3195. <short>Calculate the approximate number of hours between two DateTime values.</short>
  3196. <descr>
  3197. <var>HourSpan</var> returns the number of Hours between <var>ANow</var> and
  3198. <var>AThen</var>, including any fractional parts of a Hour.
  3199. </descr>
  3200. <seealso>
  3201. <link id="YearSpan"/>
  3202. <link id="MonthSpan"/>
  3203. <link id="WeekSpan"/>
  3204. <link id="DaySpan"/>
  3205. <link id="MinuteSpan"/>
  3206. <link id="SecondSpan"/>
  3207. <link id="MilliSecondSpan"/>
  3208. <link id="HoursBetween"/>
  3209. </seealso>
  3210. <example file="datutex/ex67"/>
  3211. </element>
  3212. <!-- function result Visibility: default -->
  3213. <element name="HourSpan.Result">
  3214. <short>Number (fractions included) of hours between <var>ANow</var> and <var>AThen</var></short>
  3215. </element>
  3216. <!-- argument Visibility: default -->
  3217. <element name="HourSpan.ANow">
  3218. <short>First moment in time</short>
  3219. </element>
  3220. <!-- argument Visibility: default -->
  3221. <element name="HourSpan.AThen">
  3222. <short>Second moment in time</short>
  3223. </element>
  3224. <!-- function Visibility: default -->
  3225. <element name="MinuteSpan">
  3226. <short>Calculate the approximate number of minutes between two DateTime values.</short>
  3227. <descr>
  3228. <var>MinuteSpan</var> returns the number of minutes between <var>ANow</var> and
  3229. <var>AThen</var>, including any fractional parts of a minute.
  3230. </descr>
  3231. <seealso>
  3232. <link id="YearSpan"/>
  3233. <link id="MonthSpan"/>
  3234. <link id="WeekSpan"/>
  3235. <link id="DaySpan"/>
  3236. <link id="HourSpan"/>
  3237. <link id="SecondSpan"/>
  3238. <link id="MilliSecondSpan"/>
  3239. <link id="MinutesBetween"/>
  3240. </seealso>
  3241. <example file="datutex/ex68"/>
  3242. </element>
  3243. <!-- function result Visibility: default -->
  3244. <element name="MinuteSpan.Result">
  3245. <short>Number (fractions included) of minutes between <var>ANow</var> and <var>AThen</var></short>
  3246. </element>
  3247. <!-- argument Visibility: default -->
  3248. <element name="MinuteSpan.ANow">
  3249. <short>First moment in time</short>
  3250. </element>
  3251. <!-- argument Visibility: default -->
  3252. <element name="MinuteSpan.AThen">
  3253. <short>Second moment in time</short>
  3254. </element>
  3255. <!-- function Visibility: default -->
  3256. <element name="SecondSpan">
  3257. <short>Calculate the approximate number of seconds between two DateTime values.</short>
  3258. <descr>
  3259. <var>SecondSpan</var> returns the number of seconds between <var>ANow</var> and
  3260. <var>AThen</var>, including any fractional parts of a second.
  3261. </descr>
  3262. <seealso>
  3263. <link id="YearSpan"/>
  3264. <link id="MonthSpan"/>
  3265. <link id="WeekSpan"/>
  3266. <link id="DaySpan"/>
  3267. <link id="HourSpan"/>
  3268. <link id="MinuteSpan"/>
  3269. <link id="MilliSecondSpan"/>
  3270. <link id="SecondsBetween"/>
  3271. </seealso>
  3272. <example file="datutex/ex69"/>
  3273. </element>
  3274. <!-- function result Visibility: default -->
  3275. <element name="SecondSpan.Result">
  3276. <short>Number (fractions included) of seconds between <var>ANow</var> and <var>AThen</var></short>
  3277. </element>
  3278. <!-- argument Visibility: default -->
  3279. <element name="SecondSpan.ANow">
  3280. <short>First moment in time</short>
  3281. </element>
  3282. <!-- argument Visibility: default -->
  3283. <element name="SecondSpan.AThen">
  3284. <short>Second moment in time</short>
  3285. </element>
  3286. <!-- function Visibility: default -->
  3287. <element name="MilliSecondSpan">
  3288. <short>Calculate the approximate number of milliseconds between two DateTime values.</short>
  3289. <descr>
  3290. <var>MilliSecondSpan</var> returns the number of milliseconds between <var>ANow</var> and
  3291. <var>AThen</var>. Since millisecond is the smallest fraction of a
  3292. <var>TDateTime</var> indication, the returned number will always be an
  3293. integer value.
  3294. </descr>
  3295. <seealso>
  3296. <link id="YearSpan"/>
  3297. <link id="MonthSpan"/>
  3298. <link id="WeekSpan"/>
  3299. <link id="DaySpan"/>
  3300. <link id="HourSpan"/>
  3301. <link id="MinuteSpan"/>
  3302. <link id="SecondSpan"/>
  3303. <link id="MilliSecondsBetween"/>
  3304. </seealso>
  3305. <example file="datutex/ex70"/>
  3306. </element>
  3307. <!-- function result Visibility: default -->
  3308. <element name="MilliSecondSpan.Result">
  3309. <short>Number (fractions included) of seconds between <var>ANow</var> and <var>AThen</var></short>
  3310. </element>
  3311. <!-- argument Visibility: default -->
  3312. <element name="MilliSecondSpan.ANow">
  3313. <short>First moment in time</short>
  3314. </element>
  3315. <!-- argument Visibility: default -->
  3316. <element name="MilliSecondSpan.AThen">
  3317. <short>Second moment in time</short>
  3318. </element>
  3319. <!-- function Visibility: default -->
  3320. <element name="IncYear">
  3321. <short>Increase a DateTime value with a number of years.</short>
  3322. <descr>
  3323. <var>IncYear</var> adds <var>ANumberOfYears</var> years to <var>AValue</var> and
  3324. returns the resulting date/time. <var>ANumberOfYears</var> can be positive or
  3325. negative.
  3326. </descr>
  3327. <seealso>
  3328. <link id="#rtl.sysutils.IncMonth"/>
  3329. <link id="IncWeek"/>
  3330. <link id="IncDay"/>
  3331. <link id="IncHour"/>
  3332. <link id="IncMinute"/>
  3333. <link id="IncSecond"/>
  3334. <link id="IncMilliSecond"/>
  3335. </seealso>
  3336. <example file="datutex/ex71"/>
  3337. </element>
  3338. <!-- function result Visibility: default -->
  3339. <element name="IncYear.Result">
  3340. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfYears</var> years.</short>
  3341. </element>
  3342. <!-- argument Visibility: default -->
  3343. <element name="IncYear.AValue">
  3344. <short>DateTime to which years should be added.</short>
  3345. </element>
  3346. <!-- argument Visibility: default -->
  3347. <element name="IncYear.ANumberOfYears">
  3348. <short>Number of years to add</short>
  3349. </element>
  3350. <!-- argument Visibility: default -->
  3351. <element name="IncWeek.ANumberOfWeeks">
  3352. <short>Number of weeks to add</short>
  3353. </element>
  3354. <!-- function Visibility: default -->
  3355. <element name="IncWeek">
  3356. <short>Increase a DateTime value with a number of weeks.</short>
  3357. <descr>
  3358. <var>IncWeek</var> adds <var>ANumberOfWeeks</var> weeks to <var>AValue</var> and
  3359. returns the resulting date/time.<var>ANumberOfWeeks</var> can be positive or
  3360. negative.
  3361. </descr>
  3362. <seealso>
  3363. <link id="IncYear"/>
  3364. <link id="#rtl.sysutils.IncMonth"/>
  3365. <link id="IncDay"/>
  3366. <link id="IncHour"/>
  3367. <link id="IncMinute"/>
  3368. <link id="IncSecond"/>
  3369. <link id="IncMilliSecond"/>
  3370. </seealso>
  3371. <example file="datutex/ex73"/>
  3372. </element>
  3373. <!-- function result Visibility: default -->
  3374. <element name="IncWeek.Result">
  3375. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfWeeks</var> weeks.</short>
  3376. </element>
  3377. <!-- argument Visibility: default -->
  3378. <element name="IncWeek.AValue">
  3379. <short>DateTime to which weeks should be added.</short>
  3380. </element>
  3381. <!-- argument Visibility: default -->
  3382. <element name="IncDay.ANumberOfDays">
  3383. <short>Number of days to add.</short>
  3384. </element>
  3385. <!-- function Visibility: default -->
  3386. <element name="IncDay">
  3387. <short>Increase a DateTime value with a number of days.</short>
  3388. <descr>
  3389. <var>IncDay</var> adds <var>ANumberOfDays</var> days to <var>AValue</var> and
  3390. returns the resulting date/time.<var>ANumberOfDays</var> can be positive or
  3391. negative.
  3392. </descr>
  3393. <seealso>
  3394. <link id="IncYear"/>
  3395. <link id="#rtl.sysutils.IncMonth"/>
  3396. <link id="IncWeek"/>
  3397. <link id="IncHour"/>
  3398. <link id="IncMinute"/>
  3399. <link id="IncSecond"/>
  3400. <link id="IncMilliSecond"/>
  3401. </seealso>
  3402. <example file="datutex/ex74"/>
  3403. </element>
  3404. <!-- function result Visibility: default -->
  3405. <element name="IncDay.Result">
  3406. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfDays</var> days.</short>
  3407. </element>
  3408. <!-- argument Visibility: default -->
  3409. <element name="IncDay.AValue">
  3410. <short>DateTime value to which days should be added.</short>
  3411. </element>
  3412. <!-- argument Visibility: default -->
  3413. <element name="IncHour.ANumberOfHours">
  3414. <short>Number of hours to add</short>
  3415. </element>
  3416. <!-- function Visibility: default -->
  3417. <element name="IncHour">
  3418. <short>Increase a DateTime value with a number of hours.</short>
  3419. <descr>
  3420. <var>IncHour</var> adds <var>ANumberOfHours</var> hours to <var>AValue</var> and
  3421. returns the resulting date/time.<var>ANumberOfHours</var> can be positive or
  3422. negative.
  3423. </descr>
  3424. <seealso>
  3425. <link id="IncYear"/>
  3426. <link id="#rtl.sysutils.IncMonth"/>
  3427. <link id="IncWeek"/>
  3428. <link id="IncDay"/>
  3429. <link id="IncMinute"/>
  3430. <link id="IncSecond"/>
  3431. <link id="IncMilliSecond"/>
  3432. </seealso>
  3433. <example file="datutex/ex75"/>
  3434. </element>
  3435. <!-- function result Visibility: default -->
  3436. <element name="IncHour.Result">
  3437. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfHours</var> hours.</short>
  3438. </element>
  3439. <!-- argument Visibility: default -->
  3440. <element name="IncHour.AValue">
  3441. <short>DateTime to which hours should be added.</short>
  3442. </element>
  3443. <!-- argument Visibility: default -->
  3444. <element name="IncMinute.ANumberOfMinutes">
  3445. <short>Number of minutes to add</short>
  3446. </element>
  3447. <!-- function Visibility: default -->
  3448. <element name="IncMinute">
  3449. <short>Increase a DateTime value with a number of minutes.</short>
  3450. <descr>
  3451. <var>IncMinute</var> adds <var>ANumberOfMinutes</var> minutes to <var>AValue</var> and
  3452. returns the resulting date/time.<var>ANumberOfMinutes</var> can be positive or
  3453. negative.
  3454. </descr>
  3455. <seealso>
  3456. <link id="IncYear"/>
  3457. <link id="#rtl.sysutils.IncMonth"/>
  3458. <link id="IncWeek"/>
  3459. <link id="IncDay"/>
  3460. <link id="IncHour"/>
  3461. <link id="IncSecond"/>
  3462. <link id="IncMilliSecond"/>
  3463. </seealso>
  3464. <example file="datutex/ex76"/>
  3465. </element>
  3466. <!-- function result Visibility: default -->
  3467. <element name="IncMinute.Result">
  3468. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfMinutes</var> minutes.</short>
  3469. </element>
  3470. <!-- argument Visibility: default -->
  3471. <element name="IncMinute.AValue">
  3472. <short>DateTime to which minutes should be added.</short>
  3473. </element>
  3474. <!-- argument Visibility: default -->
  3475. <element name="IncSecond.ANumberOfSeconds">
  3476. <short>Number of seconds to add</short>
  3477. </element>
  3478. <!-- function Visibility: default -->
  3479. <element name="IncSecond">
  3480. <short>Increase a DateTime value with a number of seconds.</short>
  3481. <descr>
  3482. <var>IncSecond</var> adds <var>ANumberOfSeconds</var> seconds to <var>AValue</var> and
  3483. returns the resulting date/time.<var>ANumberOfSeconds</var> can be positive or
  3484. negative.
  3485. </descr>
  3486. <seealso>
  3487. <link id="IncYear"/>
  3488. <link id="#rtl.sysutils.IncMonth"/>
  3489. <link id="IncWeek"/>
  3490. <link id="IncDay"/>
  3491. <link id="IncHour"/>
  3492. <link id="IncSecond"/>
  3493. <link id="IncMilliSecond"/>
  3494. </seealso>
  3495. <example file="datutex/ex77"/>
  3496. </element>
  3497. <!-- function result Visibility: default -->
  3498. <element name="IncSecond.Result">
  3499. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfSeconds</var> seconds.</short>
  3500. </element>
  3501. <!-- argument Visibility: default -->
  3502. <element name="IncSecond.AValue">
  3503. <short>DateTime to which seconds should be added.</short>
  3504. </element>
  3505. <!-- argument Visibility: default -->
  3506. <element name="IncMilliSecond.ANumberOfMilliSeconds">
  3507. <short>Number of milliseconds to add</short>
  3508. </element>
  3509. <!-- function Visibility: default -->
  3510. <element name="IncMilliSecond">
  3511. <short>Increase a DateTime value with a number of milliseconds.</short>
  3512. <descr>
  3513. <var>IncMilliSecond</var> adds <var>ANumberOfMilliSeconds</var> milliseconds to <var>AValue</var> and
  3514. returns the resulting date/time.<var>ANumberOfMilliSeconds</var> can be positive or
  3515. negative.
  3516. </descr>
  3517. <seealso>
  3518. <link id="IncYear"/>
  3519. <link id="#rtl.sysutils.IncMonth"/>
  3520. <link id="IncWeek"/>
  3521. <link id="IncDay"/>
  3522. <link id="IncHour"/>
  3523. <link id="IncSecond"/>
  3524. <link id="IncMilliSecond"/>
  3525. </seealso>
  3526. <example file="datutex/ex78"/>
  3527. </element>
  3528. <!-- function result Visibility: default -->
  3529. <element name="IncMilliSecond.Result">
  3530. <short>DateTime representing <var>AValue</var> plus <var>ANumberOfMilliSeconds</var> milliseconds.</short>
  3531. </element>
  3532. <!-- argument Visibility: default -->
  3533. <element name="IncMilliSecond.AValue">
  3534. <short>DateTime to which milliseconds should be added.</short>
  3535. </element>
  3536. <!-- function Visibility: default -->
  3537. <element name="EncodeDateTime">
  3538. <short>Encodes a DateTime value from all its parts</short>
  3539. <descr>
  3540. <p>
  3541. <var>EncodeDateTime</var> encodes the values <var>AYear</var>
  3542. <var>AMonth</var>, <var>ADay</var>,<var>AHour</var>,
  3543. <var>AMinute</var>,<var>ASecond</var> and <var>AMilliSecond</var>
  3544. to a date/time valueand returns this value.
  3545. </p>
  3546. <p>
  3547. For an example, see <link id="DecodeDateTime"/>.
  3548. </p>
  3549. </descr>
  3550. <errors>
  3551. If any of the arguments is not valid, then an <var>EConvertError</var>
  3552. exception is raised.
  3553. </errors>
  3554. <seealso>
  3555. <link id="DecodeDateTime"/>
  3556. <link id="EncodeDateMonthWeek"/>
  3557. <link id="EncodeDateWeek"/>
  3558. <link id="EncodeDateDay"/>
  3559. <link id="TryEncodeDateTime"/>
  3560. <link id="TryEncodeDateWeek"/>
  3561. <link id="TryEncodeDateDay"/>
  3562. <link id="TryEncodeDateMonthWeek"/>
  3563. </seealso>
  3564. </element>
  3565. <!-- function result Visibility: default -->
  3566. <element name="EncodeDateTime.Result">
  3567. <short>DateTime value representing the complete timestamp</short>
  3568. </element>
  3569. <!-- argument Visibility: default -->
  3570. <element name="EncodeDateTime.AYear">
  3571. <short>Year</short>
  3572. </element>
  3573. <!-- argument Visibility: default -->
  3574. <element name="EncodeDateTime.AMonth">
  3575. <short>Month</short>
  3576. </element>
  3577. <!-- argument Visibility: default -->
  3578. <element name="EncodeDateTime.ADay">
  3579. <short>Day of the month</short>
  3580. </element>
  3581. <!-- argument Visibility: default -->
  3582. <element name="EncodeDateTime.AHour">
  3583. <short>Hour of the day</short>
  3584. </element>
  3585. <!-- argument Visibility: default -->
  3586. <element name="EncodeDateTime.AMinute">
  3587. <short>Minutes</short>
  3588. </element>
  3589. <!-- argument Visibility: default -->
  3590. <element name="EncodeDateTime.ASecond">
  3591. <short>Seconds</short>
  3592. </element>
  3593. <!-- argument Visibility: default -->
  3594. <element name="EncodeDateTime.AMilliSecond">
  3595. <short>Milliseconds</short>
  3596. </element>
  3597. <!-- procedure Visibility: default -->
  3598. <element name="DecodeDateTime">
  3599. <short>Decode a datetime value in a date and time value</short>
  3600. <descr>
  3601. <var>DecodeDateTime</var> decomposes the date/time indication in
  3602. <var>AValue</var> and returns the various components in <var>AYear</var>,
  3603. <var>AMonth</var>, <var>ADay</var>, <var>AHour</var>, <var>AMinute</var>,
  3604. <var>ASecond</var>, <var>AMilliSecond</var>
  3605. </descr>
  3606. <seealso>
  3607. <link id="EncodeDateTime"/>
  3608. <link id="EncodeDateMonthWeek"/>
  3609. <link id="EncodeDateWeek"/>
  3610. <link id="EncodeDateDay"/>
  3611. <link id="DecodeDateWeek"/>
  3612. <link id="DecodeDateDay"/>
  3613. <link id="DecodeDateMonthWeek"/>
  3614. </seealso>
  3615. <example file="datutex/ex79"/>
  3616. </element>
  3617. <!-- argument Visibility: default -->
  3618. <element name="DecodeDateTime.AValue">
  3619. <short>DateTime to decode</short>
  3620. </element>
  3621. <!-- argument Visibility: default -->
  3622. <element name="DecodeDateTime.AYear">
  3623. <short>Returns the year part of <var>AValue</var>.</short>
  3624. </element>
  3625. <!-- argument Visibility: default -->
  3626. <element name="DecodeDateTime.AMonth">
  3627. <short>Returns the month part of <var>AValue</var>.</short>
  3628. </element>
  3629. <!-- argument Visibility: default -->
  3630. <element name="DecodeDateTime.ADay">
  3631. <short>Returns the day part of <var>AValue</var>.</short>
  3632. </element>
  3633. <!-- argument Visibility: default -->
  3634. <element name="DecodeDateTime.AHour">
  3635. <short>Returns the hour part of <var>AValue</var>.</short>
  3636. </element>
  3637. <!-- argument Visibility: default -->
  3638. <element name="DecodeDateTime.AMinute">
  3639. <short>Returns the minute part of <var>AValue</var>.</short>
  3640. </element>
  3641. <!-- argument Visibility: default -->
  3642. <element name="DecodeDateTime.ASecond">
  3643. <short>Returns the second part of <var>AValue</var>.</short>
  3644. </element>
  3645. <!-- argument Visibility: default -->
  3646. <element name="DecodeDateTime.AMilliSecond">
  3647. <short>Returns the millisecond part of <var>AValue</var>.</short>
  3648. </element>
  3649. <!-- function Visibility: default -->
  3650. <element name="TryEncodeDateTime">
  3651. <short>Encode a Year, Month, Day, Hour, minute, seconds, milliseconds tuplet to a <var>TDateTime</var> value</short>
  3652. <descr>
  3653. <p>
  3654. <var>EncodeDateTime</var> encodes the values <var>AYear</var>
  3655. <var>AMonth</var>, <var>ADay</var>,<var>AHour</var>,
  3656. <var>AMinute</var>,<var>ASecond</var> and <var>AMilliSecond</var>
  3657. to a date/time valueand returns this value in <var>AValue</var>.
  3658. </p>
  3659. <p>
  3660. If the date was encoded succesfully, <var>True</var> is returned,
  3661. <var>False</var> is returned if one of the arguments is not valid.
  3662. </p>
  3663. </descr>
  3664. <seealso>
  3665. <link id="EncodeDateTime"/>
  3666. <link id="EncodeDateMonthWeek"/>
  3667. <link id="EncodeDateWeek"/>
  3668. <link id="EncodeDateDay"/>
  3669. <link id="TryEncodeDateDay"/>
  3670. <link id="TryEncodeDateWeek"/>
  3671. <link id="TryEncodeDateMonthWeek"/>
  3672. </seealso>
  3673. <example file="datutex/ex80"/>
  3674. </element>
  3675. <!-- function result Visibility: default -->
  3676. <element name="TryEncodeDateTime.Result">
  3677. <short><var>True</var> if the encoding was succesful</short>
  3678. </element>
  3679. <!-- argument Visibility: default -->
  3680. <element name="TryEncodeDateTime.AYear">
  3681. <short>Year</short>
  3682. </element>
  3683. <!-- argument Visibility: default -->
  3684. <element name="TryEncodeDateTime.AMonth">
  3685. <short>Month in year</short>
  3686. </element>
  3687. <!-- argument Visibility: default -->
  3688. <element name="TryEncodeDateTime.ADay">
  3689. <short>Day in month</short>
  3690. </element>
  3691. <!-- argument Visibility: default -->
  3692. <element name="TryEncodeDateTime.AHour">
  3693. <short>Hour of the day</short>
  3694. </element>
  3695. <!-- argument Visibility: default -->
  3696. <element name="TryEncodeDateTime.AMinute">
  3697. <short>Minutes in the hour</short>
  3698. </element>
  3699. <!-- argument Visibility: default -->
  3700. <element name="TryEncodeDateTime.ASecond">
  3701. <short>Seconds in the minute</short>
  3702. </element>
  3703. <!-- argument Visibility: default -->
  3704. <element name="TryEncodeDateTime.AMilliSecond">
  3705. <short>Millisecond in the second</short>
  3706. </element>
  3707. <!-- argument Visibility: default -->
  3708. <element name="TryEncodeDateTime.AValue">
  3709. <short>Encoded <var>TDateTime</var> value.</short>
  3710. </element>
  3711. <!-- function Visibility: default -->
  3712. <element name="EncodeDateWeek">
  3713. <short>Encode a <var>TDateTime</var> value from a year, week and day of week triplet</short>
  3714. <descr>
  3715. <p>
  3716. <var>EncodeDateWeek</var> encodes the values <var>AYear</var>, <var>AWeekOfYear</var>
  3717. and <var>ADayOfWeek</var> to a date value and returns this value.
  3718. </p>
  3719. <p>
  3720. For an example, see <link id="DecodeDateWeek"/>.
  3721. </p>
  3722. </descr>
  3723. <errors>
  3724. If any of the arguments is not valid, then an <var>EConvertError</var>
  3725. exception is raised.
  3726. </errors>
  3727. <seealso>
  3728. <link id="EncodeDateMonthWeek"/>
  3729. <link id="DecodeDateWeek"/>
  3730. <link id="EncodeDateTime"/>
  3731. <link id="EncodeDateDay"/>
  3732. <link id="TryEncodeDateTime"/>
  3733. <link id="TryEncodeDateWeek"/>
  3734. <link id="TryEncodeDateMonthWeek"/>
  3735. </seealso>
  3736. </element>
  3737. <!-- function result Visibility: default -->
  3738. <element name="EncodeDateWeek.Result">
  3739. <short>DateTime value representing <var>AYear</var>, <var>AWeekOfYear</var> and <var>ADayOfWeek</var>.</short>
  3740. </element>
  3741. <!-- argument Visibility: default -->
  3742. <element name="EncodeDateWeek.AYear">
  3743. <short>Year part</short>
  3744. </element>
  3745. <!-- argument Visibility: default -->
  3746. <element name="EncodeDateWeek.AWeekOfYear">
  3747. <short>Week of the year part</short>
  3748. </element>
  3749. <!-- procedure Visibility: default -->
  3750. <element name="DecodeDateWeek">
  3751. <short>Decode a DateTime value in a week of year and day of week.</short>
  3752. <descr>
  3753. <var>DecodeDateWeek</var> decomposes the date indication in
  3754. <var>AValue</var> and returns the various components in <var>AYear</var>,
  3755. <var>AWeekOfYear</var>, <var>ADayOfWeek</var>.
  3756. </descr>
  3757. <seealso>
  3758. <link id="EncodeDateTime"/>
  3759. <link id="EncodeDateMonthWeek"/>
  3760. <link id="EncodeDateWeek"/>
  3761. <link id="EncodeDateDay"/>
  3762. <link id="DecodeDateTime"/>
  3763. <link id="DecodeDateDay"/>
  3764. <link id="DecodeDateMonthWeek"/>
  3765. </seealso>
  3766. <example file="datutex/ex81"/>
  3767. </element>
  3768. <!-- argument Visibility: default -->
  3769. <element name="DecodeDateWeek.AValue">
  3770. <short>DateTime to decode</short>
  3771. </element>
  3772. <!-- argument Visibility: default -->
  3773. <element name="DecodeDateWeek.AYear">
  3774. <short>Returns the year part of <var>AValue</var>.</short>
  3775. </element>
  3776. <!-- argument Visibility: default -->
  3777. <element name="DecodeDateWeek.AWeekOfYear">
  3778. <short>Returns the week of year part of <var>AValue</var>.</short>
  3779. </element>
  3780. <!-- argument Visibility: default -->
  3781. <element name="DecodeDateWeek.ADayOfWeek">
  3782. <short>Returns the day of week part of <var>AValue</var>.</short>
  3783. </element>
  3784. <!-- function Visibility: default -->
  3785. <element name="TryEncodeDateWeek">
  3786. <short>Encode a year, week and day of week triplet to a <var>TDateTime</var> value</short>
  3787. <descr>
  3788. <p>
  3789. <var>TryEncodeDateWeek</var> encodes the values <var>AYear</var>, <var>AWeekOfYear</var>
  3790. and <var>ADayOfWeek</var> to a date value and returns this value in
  3791. <var>AValue</var>.
  3792. </p>
  3793. <p>
  3794. If the encoding was succcesful, <var>True</var> is returned.
  3795. <var>False</var> is returned if any of the arguments is not valid.
  3796. </p>
  3797. </descr>
  3798. <seealso>
  3799. <link id="EncodeDateMonthWeek"/>
  3800. <link id="EncodeDateWeek"/>
  3801. <link id="EncodeDateTime"/>
  3802. <link id="EncodeDateDay"/>
  3803. <link id="TryEncodeDateTime"/>
  3804. <link id="TryEncodeDateMonthWeek"/>
  3805. <link id="TryEncodeDateDay"/>
  3806. </seealso>
  3807. <example file="datutex/ex82"/>
  3808. </element>
  3809. <!-- function result Visibility: default -->
  3810. <element name="TryEncodeDateWeek.Result">
  3811. <short><var>True</var> if the encoding was succeful, <var>False</var> otherwise.</short>
  3812. </element>
  3813. <!-- argument Visibility: default -->
  3814. <element name="TryEncodeDateWeek.AYear">
  3815. <short>Year</short>
  3816. </element>
  3817. <!-- argument Visibility: default -->
  3818. <element name="TryEncodeDateWeek.AWeekOfYear">
  3819. <short>Week in the year</short>
  3820. </element>
  3821. <!-- argument Visibility: default -->
  3822. <element name="TryEncodeDateWeek.AValue">
  3823. <short>Encoded <var>TDateTime</var> value</short>
  3824. </element>
  3825. <!-- argument Visibility: default -->
  3826. <element name="TryEncodeDateWeek.ADayOfWeek">
  3827. <short>Day of the week (default 1).</short>
  3828. </element>
  3829. <!-- function Visibility: default -->
  3830. <element name="EncodeDateDay">
  3831. <short>Encodes a year and day of year to a DateTime value</short>
  3832. <descr>
  3833. <p>
  3834. <var>EncodeDateDay</var> encodes the values <var>AYear</var> and <var>ADayOfYear</var>
  3835. to a date value and returns this value.
  3836. </p>
  3837. <p>
  3838. For an example, see <link id="DecodeDateDay"/>.
  3839. </p>
  3840. </descr>
  3841. <errors>
  3842. If any of the arguments is not valid, then an <var>EConvertError</var>
  3843. exception is raised.
  3844. </errors>
  3845. <seealso>
  3846. <link id="EncodeDateMonthWeek"/>
  3847. <link id="DecodeDateDay"/>
  3848. <link id="EncodeDateTime"/>
  3849. <link id="EncodeDateWeek"/>
  3850. <link id="TryEncodeDateTime"/>
  3851. <link id="TryEncodeDateMonthWeek"/>
  3852. <link id="TryEncodeDateWeek"/>
  3853. </seealso>
  3854. </element>
  3855. <!-- function result Visibility: default -->
  3856. <element name="EncodeDateDay.Result">
  3857. <short>DateTime value representing the date specified by <var>AYear</var> and <var>ADayOfYear</var>.</short>
  3858. </element>
  3859. <!-- argument Visibility: default -->
  3860. <element name="EncodeDateDay.AYear">
  3861. <short>Year part.</short>
  3862. </element>
  3863. <!-- argument Visibility: default -->
  3864. <element name="EncodeDateDay.ADayOfYear">
  3865. <short>Day of the year part</short>
  3866. </element>
  3867. <!-- procedure Visibility: default -->
  3868. <element name="DecodeDateDay">
  3869. <short>Decode a DateTime value in year and year of day.</short>
  3870. <descr>
  3871. <var>DecodeDateDay</var> decomposes the date indication in
  3872. <var>AValue</var> and returns the various components in <var>AYear</var>,
  3873. <var>ADayOfYear</var>.
  3874. </descr>
  3875. <seealso>
  3876. <link id="EncodeDateTime"/>
  3877. <link id="EncodeDateMonthWeek"/>
  3878. <link id="EncodeDateWeek"/>
  3879. <link id="EncodeDateDay"/>
  3880. <link id="DecodeDateTime"/>
  3881. <link id="DecodeDateWeek"/>
  3882. <link id="DecodeDateMonthWeek"/>
  3883. </seealso>
  3884. <example file="datutex/ex83"/>
  3885. </element>
  3886. <!-- argument Visibility: default -->
  3887. <element name="DecodeDateDay.AValue">
  3888. <short>DateTime to decode</short>
  3889. </element>
  3890. <!-- argument Visibility: default -->
  3891. <element name="DecodeDateDay.AYear">
  3892. <short>Returns the year part of <var>AValue</var></short>
  3893. </element>
  3894. <!-- argument Visibility: default -->
  3895. <element name="DecodeDateDay.ADayOfYear">
  3896. <short>Returns the day-of-year part of <var>AValue</var></short>
  3897. </element>
  3898. <!-- function Visibility: default -->
  3899. <element name="TryEncodeDateDay">
  3900. <short>Encode a year and day of year to a <var>TDateTime</var> value</short>
  3901. <descr>
  3902. <p>
  3903. <var>TryEncodeDateDay</var> encodes the values <var>AYear</var>
  3904. and <var>ADayOfYear</var> to a date value and returns this value in
  3905. <var>AValue</var>.
  3906. </p>
  3907. <p>
  3908. If the encoding was succcesful, <var>True</var> is returned.
  3909. <var>False</var> is returned if any of the arguments is not valid.
  3910. </p>
  3911. </descr>
  3912. <seealso>
  3913. <link id="EncodeDateDay"/>
  3914. <link id="EncodeDateTime"/>
  3915. <link id="EncodeDateMonthWeek"/>
  3916. <link id="EncodeDateWeek"/>
  3917. <link id="TryEncodeDateTime"/>
  3918. <link id="TryEncodeDateMonthWeek"/>
  3919. <link id="TryEncodeDateWeek"/>
  3920. </seealso>
  3921. <example file="datutex/ex84"/>
  3922. </element>
  3923. <!-- function result Visibility: default -->
  3924. <element name="TryEncodeDateDay.Result">
  3925. <short><var>True</var> if the encoding was succesful, <var>False</var> if not.</short>
  3926. </element>
  3927. <!-- argument Visibility: default -->
  3928. <element name="TryEncodeDateDay.AYear">
  3929. <short>Year</short>
  3930. </element>
  3931. <!-- argument Visibility: default -->
  3932. <element name="TryEncodeDateDay.ADayOfYear">
  3933. <short>Day in the year</short>
  3934. </element>
  3935. <!-- argument Visibility: default -->
  3936. <element name="TryEncodeDateDay.AValue">
  3937. <short>Encoded <var>TDateTime</var> value.</short>
  3938. </element>
  3939. <!-- function Visibility: default -->
  3940. <element name="EncodeDateMonthWeek">
  3941. <short>Encodes a year, month, week of month and day of week to a DateTime value</short>
  3942. <descr>
  3943. <p>
  3944. <var>EncodeDateTime</var> encodes the values <var>AYear</var>
  3945. <var>AMonth</var>, <var>WeekOfMonth</var>,<var>ADayOfWeek</var>,
  3946. to a date value and returns this value.
  3947. </p>
  3948. <p>
  3949. For an example, see <link id="DecodeDateMonthWeek"/>.
  3950. </p>
  3951. </descr>
  3952. <errors>
  3953. If any of the arguments is not valid, then an <var>EConvertError</var>
  3954. exception is raised.
  3955. </errors>
  3956. <seealso>
  3957. <link id="DecodeDateMonthWeek"/>
  3958. <link id="EncodeDateTime"/>
  3959. <link id="EncodeDateWeek"/>
  3960. <link id="EncodeDateDay"/>
  3961. <link id="TryEncodeDateTime"/>
  3962. <link id="TryEncodeDateWeek"/>
  3963. <link id="TryEncodeDateMonthWeek"/>
  3964. <link id="TryEncodeDateDay"/>
  3965. <link id="NthDayOfWeek"/>
  3966. </seealso>
  3967. </element>
  3968. <!-- function result Visibility: default -->
  3969. <element name="EncodeDateMonthWeek.Result">
  3970. <short>DateTime value representing the date specified by <var>AYear</var>, <var>AMonth</var>, <var>AWeekOfMonth</var> and <var>ADayOfWeek</var>.</short>
  3971. </element>
  3972. <!-- argument Visibility: default -->
  3973. <element name="EncodeDateMonthWeek.AYear">
  3974. <short>Year part</short>
  3975. </element>
  3976. <!-- argument Visibility: default -->
  3977. <element name="EncodeDateMonthWeek.AMonth">
  3978. <short>Month part</short>
  3979. </element>
  3980. <!-- argument Visibility: default -->
  3981. <element name="EncodeDateMonthWeek.AWeekOfMonth">
  3982. <short>Week of the month part</short>
  3983. </element>
  3984. <!-- argument Visibility: default -->
  3985. <element name="EncodeDateMonthWeek.ADayOfWeek">
  3986. <short>Day of the week part</short>
  3987. </element>
  3988. <!-- procedure Visibility: default -->
  3989. <element name="DecodeDateMonthWeek">
  3990. <short>Decode a DateTime value in a month, week of month and day of week</short>
  3991. <descr>
  3992. <var>DecodeDateMonthWeek</var> decomposes the date indication in
  3993. <var>AValue</var> and returns the various components in <var>AYear</var>,
  3994. <var>AMonth</var> <var>AWeekOfMonth</var> and <var>ADayOfWeek</var>.
  3995. </descr>
  3996. <seealso>
  3997. <link id="EncodeDateTime"/>
  3998. <link id="EncodeDateMonthWeek"/>
  3999. <link id="EncodeDateWeek"/>
  4000. <link id="EncodeDateDay"/>
  4001. <link id="DecodeDateTime"/>
  4002. <link id="DecodeDateWeek"/>
  4003. <link id="DecodeDateDay"/>
  4004. </seealso>
  4005. <example file="datutex/ex85"/>
  4006. </element>
  4007. <!-- argument Visibility: default -->
  4008. <element name="DecodeDateMonthWeek.AValue">
  4009. <short>DateTime to decode</short>
  4010. </element>
  4011. <!-- argument Visibility: default -->
  4012. <element name="DecodeDateMonthWeek.AYear">
  4013. <short>Returns the year part of <var>AValue</var>.</short>
  4014. </element>
  4015. <!-- argument Visibility: default -->
  4016. <element name="DecodeDateMonthWeek.AMonth">
  4017. <short>Returns the month part of <var>AValue</var>.</short>
  4018. </element>
  4019. <!-- argument Visibility: default -->
  4020. <element name="DecodeDateMonthWeek.AWeekOfMonth">
  4021. <short>Returns the week of month part of <var>AValue</var>.</short>
  4022. </element>
  4023. <!-- argument Visibility: default -->
  4024. <element name="DecodeDateMonthWeek.ADayOfWeek">
  4025. <short>Returns the day of week part of <var>AValue</var>.</short>
  4026. </element>
  4027. <!-- function Visibility: default -->
  4028. <element name="TryEncodeDateMonthWeek">
  4029. <short>Encode a year, month, week of month and day of week to a <var>TDateTime</var> value</short>
  4030. <descr>
  4031. <p>
  4032. <var>TryEncodeDateTime</var> encodes the values <var>AYear</var>
  4033. <var>AMonth</var>, <var>WeekOfMonth</var>,<var>ADayOfWeek</var>,
  4034. to a date value and returns this value in <var>AValue</var>.
  4035. </p>
  4036. <p>
  4037. If the encoding was succesful, <var>True</var> is returned, <var>False</var>
  4038. if any of the arguments is not valid.
  4039. </p>
  4040. </descr>
  4041. <seealso>
  4042. <link id="DecodeDateMonthWeek"/>
  4043. <link id="EncodeDateTime"/>
  4044. <link id="EncodeDateWeek"/>
  4045. <link id="EncodeDateDay"/>
  4046. <link id="EncodeDateMonthWeek"/>
  4047. <link id="TryEncodeDateTime"/>
  4048. <link id="TryEncodeDateWeek"/>
  4049. <link id="TryEncodeDateDay"/>
  4050. <link id="NthDayOfWeek"/>
  4051. </seealso>
  4052. <example file="datutex/ex86"/>
  4053. </element>
  4054. <!-- function result Visibility: default -->
  4055. <element name="TryEncodeDateMonthWeek.Result">
  4056. <short><var>True</var> if the encoding was succesful, <var>False</var> if not.</short>
  4057. </element>
  4058. <!-- argument Visibility: default -->
  4059. <element name="TryEncodeDateMonthWeek.AYear">
  4060. <short>Year</short>
  4061. </element>
  4062. <!-- argument Visibility: default -->
  4063. <element name="TryEncodeDateMonthWeek.AMonth">
  4064. <short>Month in the year</short>
  4065. </element>
  4066. <!-- argument Visibility: default -->
  4067. <element name="TryEncodeDateMonthWeek.AWeekOfMonth">
  4068. <short>Week in the month</short>
  4069. </element>
  4070. <!-- argument Visibility: default -->
  4071. <element name="TryEncodeDateMonthWeek.ADayOfWeek">
  4072. <short>Day in the week</short>
  4073. </element>
  4074. <!-- argument Visibility: default -->
  4075. <element name="TryEncodeDateMonthWeek.AValue">
  4076. <short>Encoded <var>TDateTime</var> value</short>
  4077. </element>
  4078. <!-- function Visibility: default -->
  4079. <element name="RecodeYear">
  4080. <short>Replace year part of a <var>TDateTime</var> value with another year.</short>
  4081. <descr>
  4082. <var>RecodeYear</var> replaces the year part of the timestamp <var>AValue</var>
  4083. with <var>AYear</var>. All other parts of the date/time stamp are left untouched.
  4084. </descr>
  4085. <errors>
  4086. If the <var>AYear</var> value is not within a valid range (1..9999) then
  4087. an <var>EConvertError</var> exception is raised.
  4088. </errors>
  4089. <seealso>
  4090. <link id="RecodeMonth"/>
  4091. <link id="RecodeDay"/>
  4092. <link id="RecodeHour"/>
  4093. <link id="RecodeMinute"/>
  4094. <link id="RecodeSecond"/>
  4095. <link id="RecodeMilliSecond"/>
  4096. <link id="RecodeDate"/>
  4097. <link id="RecodeTime"/>
  4098. <link id="RecodeDateTime"/>
  4099. </seealso>
  4100. <example file="datutex/ex87"/>
  4101. </element>
  4102. <!-- function result Visibility: default -->
  4103. <element name="RecodeYear.Result">
  4104. <short><var>AValue</var> with replaced year.</short>
  4105. </element>
  4106. <!-- argument Visibility: default -->
  4107. <element name="RecodeYear.AValue">
  4108. <short>Date to recode</short>
  4109. </element>
  4110. <!-- argument Visibility: default -->
  4111. <element name="RecodeYear.AYear">
  4112. <short>Year to replace in <var>AValue</var></short>
  4113. </element>
  4114. <!-- function Visibility: default -->
  4115. <element name="RecodeMonth">
  4116. <short>Replace month part of a <var>TDateTime</var> value with another month.</short>
  4117. <descr>
  4118. <var>RecodeMonth</var> replaces the Month part of the timestamp <var>AValue</var>
  4119. with <var>AMonth</var>. All other parts of the date/time stamp are left untouched.
  4120. </descr>
  4121. <errors>
  4122. If the <var>AMonth</var> value is not within a valid range (1..12) then
  4123. an <var>EConvertError</var> exception is raised.
  4124. </errors>
  4125. <seealso>
  4126. <link id="RecodeYear"/>
  4127. <link id="RecodeDay"/>
  4128. <link id="RecodeHour"/>
  4129. <link id="RecodeMinute"/>
  4130. <link id="RecodeSecond"/>
  4131. <link id="RecodeMilliSecond"/>
  4132. <link id="RecodeDate"/>
  4133. <link id="RecodeTime"/>
  4134. <link id="RecodeDateTime"/>
  4135. </seealso>
  4136. <example file="datutex/ex88"/>
  4137. </element>
  4138. <!-- function result Visibility: default -->
  4139. <element name="RecodeMonth.Result">
  4140. <short><var>AValue</var> with replaced month.</short>
  4141. </element>
  4142. <!-- argument Visibility: default -->
  4143. <element name="RecodeMonth.AValue">
  4144. <short>Date to recode</short>
  4145. </element>
  4146. <!-- argument Visibility: default -->
  4147. <element name="RecodeMonth.AMonth">
  4148. <short>Month to replace in <var>AValue</var></short>
  4149. </element>
  4150. <!-- function Visibility: default -->
  4151. <element name="RecodeDay">
  4152. <short>Replace day part of a <var>TDateTime</var> value with another day.</short>
  4153. <descr>
  4154. <var>RecodeDay</var> replaces the Day part of the timestamp <var>AValue</var>
  4155. with <var>ADay</var>. All other parts of the date/time stamp are left untouched.
  4156. </descr>
  4157. <errors>
  4158. If the <var>ADay</var> value is not within a valid range (1..12) then
  4159. an <var>EConvertError</var> exception is raised.
  4160. </errors>
  4161. <seealso>
  4162. <link id="RecodeYear"/>
  4163. <link id="RecodeMonth"/>
  4164. <link id="RecodeHour"/>
  4165. <link id="RecodeMinute"/>
  4166. <link id="RecodeSecond"/>
  4167. <link id="RecodeMilliSecond"/>
  4168. <link id="RecodeDate"/>
  4169. <link id="RecodeTime"/>
  4170. <link id="RecodeDateTime"/>
  4171. </seealso>
  4172. <example file="datutex/ex89"/>
  4173. </element>
  4174. <!-- function result Visibility: default -->
  4175. <element name="RecodeDay.Result">
  4176. <short><var>AValue</var> with replaced day.</short>
  4177. </element>
  4178. <!-- argument Visibility: default -->
  4179. <element name="RecodeDay.AValue">
  4180. <short>Date to recode</short>
  4181. </element>
  4182. <!-- argument Visibility: default -->
  4183. <element name="RecodeDay.ADay">
  4184. <short>Day to replace in <var>AValue</var></short>
  4185. </element>
  4186. <!-- function Visibility: default -->
  4187. <element name="RecodeHour">
  4188. <short>Replace hours part of a <var>TDateTime</var> value with another hour.</short>
  4189. <descr>
  4190. <var>RecodeHour</var> replaces the Hour part of the timestamp <var>AValue</var>
  4191. with <var>AHour</var>. All other parts of the date/time stamp are left untouched.
  4192. </descr>
  4193. <errors>
  4194. If the <var>AHour</var> value is not within a valid range (0..23) then
  4195. an <var>EConvertError</var> exception is raised.
  4196. </errors>
  4197. <seealso>
  4198. <link id="RecodeYear"/>
  4199. <link id="RecodeMonth"/>
  4200. <link id="RecodeDay"/>
  4201. <link id="RecodeMinute"/>
  4202. <link id="RecodeSecond"/>
  4203. <link id="RecodeMilliSecond"/>
  4204. <link id="RecodeDate"/>
  4205. <link id="RecodeTime"/>
  4206. <link id="RecodeDateTime"/>
  4207. </seealso>
  4208. <example file="datutex/ex90"/>
  4209. </element>
  4210. <!-- function result Visibility: default -->
  4211. <element name="RecodeHour.Result">
  4212. <short><var>AValue</var> with replaced hour.</short>
  4213. </element>
  4214. <!-- argument Visibility: default -->
  4215. <element name="RecodeHour.AValue">
  4216. <short>Date/time to recode</short>
  4217. </element>
  4218. <!-- argument Visibility: default -->
  4219. <element name="RecodeHour.AHour">
  4220. <short>Hour to replace in <var>AValue</var></short>
  4221. </element>
  4222. <!-- function Visibility: default -->
  4223. <element name="RecodeMinute">
  4224. <short>Replace minutse part of a <var>TDateTime</var> value with another minute.</short>
  4225. <descr>
  4226. <var>RecodeMinute</var> replaces the Minute part of the timestamp <var>AValue</var>
  4227. with <var>AMinute</var>. All other parts of the date/time stamp are left untouched.
  4228. </descr>
  4229. <errors>
  4230. If the <var>AMinute</var> value is not within a valid range (0..59) then
  4231. an <var>EConvertError</var> exception is raised.
  4232. </errors>
  4233. <seealso>
  4234. <link id="RecodeYear"/>
  4235. <link id="RecodeMonth"/>
  4236. <link id="RecodeDay"/>
  4237. <link id="RecodeHour"/>
  4238. <link id="RecodeSecond"/>
  4239. <link id="RecodeMilliSecond"/>
  4240. <link id="RecodeDate"/>
  4241. <link id="RecodeTime"/>
  4242. <link id="RecodeDateTime"/>
  4243. </seealso>
  4244. <example file="datutex/ex91"/>
  4245. </element>
  4246. <!-- function result Visibility: default -->
  4247. <element name="RecodeMinute.Result">
  4248. <short><var>AValue</var> with replaced minute.</short>
  4249. </element>
  4250. <!-- argument Visibility: default -->
  4251. <element name="RecodeMinute.AValue">
  4252. <short>Date/time to recode</short>
  4253. </element>
  4254. <!-- argument Visibility: default -->
  4255. <element name="RecodeMinute.AMinute">
  4256. <short>Minute to replace in <var>AValue</var></short>
  4257. </element>
  4258. <!-- function Visibility: default -->
  4259. <element name="RecodeSecond">
  4260. <short>Replace seconds part of a <var>TDateTime</var> value with another second.</short>
  4261. <descr>
  4262. <var>RecodeSecond</var> replaces the Second part of the timestamp <var>AValue</var>
  4263. with <var>ASecond</var>. All other parts of the date/time stamp are left untouched.
  4264. </descr>
  4265. <errors>
  4266. If the <var>ASecond</var> value is not within a valid range (0..59) then
  4267. an <var>EConvertError</var> exception is raised.
  4268. </errors>
  4269. <seealso>
  4270. <link id="RecodeYear"/>
  4271. <link id="RecodeMonth"/>
  4272. <link id="RecodeDay"/>
  4273. <link id="RecodeHour"/>
  4274. <link id="RecodeMinute"/>
  4275. <link id="RecodeMilliSecond"/>
  4276. <link id="RecodeDate"/>
  4277. <link id="RecodeTime"/>
  4278. <link id="RecodeDateTime"/>
  4279. </seealso>
  4280. <example file="datutex/ex92"/>
  4281. </element>
  4282. <!-- function result Visibility: default -->
  4283. <element name="RecodeSecond.Result">
  4284. <short><var>AValue</var> with replaced second.</short>
  4285. </element>
  4286. <!-- argument Visibility: default -->
  4287. <element name="RecodeSecond.AValue">
  4288. <short>Date/time to recode</short>
  4289. </element>
  4290. <!-- argument Visibility: default -->
  4291. <element name="RecodeSecond.ASecond">
  4292. <short>Second to replace in <var>AValue</var></short>
  4293. </element>
  4294. <!-- function Visibility: default -->
  4295. <element name="RecodeMilliSecond">
  4296. <short>Replace milliseconds part of a <var>TDateTime</var> value with another millisecond.</short>
  4297. <descr>
  4298. <var>RecodeMilliSecond</var> replaces the millisecond part of the timestamp <var>AValue</var>
  4299. with <var>AMilliSecond</var>. All other parts of the date/time stamp are left untouched.
  4300. </descr>
  4301. <errors>
  4302. If the <var>AMilliSecond</var> value is not within a valid range (0..999) then
  4303. an <var>EConvertError</var> exception is raised.
  4304. </errors>
  4305. <seealso>
  4306. <link id="RecodeYear"/>
  4307. <link id="RecodeMonth"/>
  4308. <link id="RecodeDay"/>
  4309. <link id="RecodeHour"/>
  4310. <link id="RecodeMinute"/>
  4311. <link id="RecodeSecond"/>
  4312. <link id="RecodeDate"/>
  4313. <link id="RecodeTime"/>
  4314. <link id="RecodeDateTime"/>
  4315. </seealso>
  4316. <example file="datutex/ex93"/>
  4317. </element>
  4318. <!-- function result Visibility: default -->
  4319. <element name="RecodeMilliSecond.Result">
  4320. <short><var>AValue</var> with replaced millisecond.</short>
  4321. </element>
  4322. <!-- argument Visibility: default -->
  4323. <element name="RecodeMilliSecond.AValue">
  4324. <short>Date/time to recode</short>
  4325. </element>
  4326. <!-- argument Visibility: default -->
  4327. <element name="RecodeMilliSecond.AMilliSecond">
  4328. <short>Millisecond to replace in <var>AValue</var></short>
  4329. </element>
  4330. <!-- function Visibility: default -->
  4331. <element name="RecodeDate">
  4332. <short>Replace date part of a <var>TDateTime</var> value with another date.</short>
  4333. <descr>
  4334. <var>RecodeDate</var> replaces the date part of the timestamp <var>AValue</var>
  4335. with the date specified in <var>AYear</var>, <var>AMonth</var>, <var>ADay</var>.
  4336. All other parts (the time part) of the date/time stamp are left untouched.
  4337. </descr>
  4338. <errors>
  4339. If one of the <var>AYear</var>, <var>AMonth</var>, <var>ADay</var> values is not within
  4340. a valid range then an <var>EConvertError</var> exception is raised.
  4341. </errors>
  4342. <seealso>
  4343. <link id="RecodeYear"/>
  4344. <link id="RecodeMonth"/>
  4345. <link id="RecodeDay"/>
  4346. <link id="RecodeHour"/>
  4347. <link id="RecodeMinute"/>
  4348. <link id="RecodeSecond"/>
  4349. <link id="RecodeDate"/>
  4350. <link id="RecodeTime"/>
  4351. <link id="RecodeDateTime"/>
  4352. </seealso>
  4353. <example file="datutex/ex94"/>
  4354. </element>
  4355. <!-- function result Visibility: default -->
  4356. <element name="RecodeDate.Result">
  4357. <short><var>AValue</var> with replaced date.</short>
  4358. </element>
  4359. <!-- argument Visibility: default -->
  4360. <element name="RecodeDate.AValue">
  4361. <short>Date/time to recode</short>
  4362. </element>
  4363. <!-- argument Visibility: default -->
  4364. <element name="RecodeDate.AYear">
  4365. <short>Year to replace in <var>AValue</var></short>
  4366. </element>
  4367. <!-- argument Visibility: default -->
  4368. <element name="RecodeDate.AMonth">
  4369. <short>Month to replace in <var>AValue</var></short>
  4370. </element>
  4371. <!-- argument Visibility: default -->
  4372. <element name="RecodeDate.ADay">
  4373. <short>Day to replace in <var>AValue</var></short>
  4374. </element>
  4375. <!-- function Visibility: default -->
  4376. <element name="RecodeTime">
  4377. <short>Replace time part of a <var>TDateTime</var> value with another time.</short>
  4378. <descr>
  4379. <var>RecodeTime</var> replaces the time part of the timestamp <var>AValue</var>
  4380. with the date specified in <var>AHour</var>, <var>AMinute</var>,
  4381. <var>ASecond</var> and <var>AMilliSecond</var>.
  4382. All other parts (the date part) of the date/time stamp are left untouched.
  4383. </descr>
  4384. <errors>
  4385. If one of the values <var>AHour</var>, <var>AMinute</var>, <var>ASecond</var>
  4386. <var>AMilliSecond</var> is not within a valid range then an <var>EConvertError</var>
  4387. exception is raised.
  4388. </errors>
  4389. <seealso>
  4390. <link id="RecodeYear"/>
  4391. <link id="RecodeMonth"/>
  4392. <link id="RecodeDay"/>
  4393. <link id="RecodeHour"/>
  4394. <link id="RecodeMinute"/>
  4395. <link id="RecodeSecond"/>
  4396. <link id="RecodeMilliSecond"/>
  4397. <link id="RecodeDate"/>
  4398. <link id="RecodeDateTime"/>
  4399. </seealso>
  4400. <example file="datutex/ex95"/>
  4401. </element>
  4402. <!-- function result Visibility: default -->
  4403. <element name="RecodeTime.Result">
  4404. <short><var>AValue</var> with replaced time.</short>
  4405. </element>
  4406. <!-- argument Visibility: default -->
  4407. <element name="RecodeTime.AValue">
  4408. <short>Date/time to recode</short>
  4409. </element>
  4410. <!-- argument Visibility: default -->
  4411. <element name="RecodeTime.AHour">
  4412. <short>Hour to replace in <var>AValue</var></short>
  4413. </element>
  4414. <!-- argument Visibility: default -->
  4415. <element name="RecodeTime.AMinute">
  4416. <short>Minute to replace in <var>AValue</var></short>
  4417. </element>
  4418. <!-- argument Visibility: default -->
  4419. <element name="RecodeTime.ASecond">
  4420. <short>Second to replace in <var>AValue</var></short>
  4421. </element>
  4422. <!-- argument Visibility: default -->
  4423. <element name="RecodeTime.AMilliSecond">
  4424. <short>Millisecond to replace in <var>AValue</var></short>
  4425. </element>
  4426. <!-- function Visibility: default -->
  4427. <element name="RecodeDateTime">
  4428. <short>Replace selected parts of a <var>TDateTime</var> value with other values </short>
  4429. <descr>
  4430. <var>RecodeDateTime</var> replaces selected parts of the timestamp <var>AValue</var>
  4431. with the date/time values specified in <var>AYear</var>, <var>AMonth</var>,
  4432. <var>ADay</var>, <var>AHour</var>, <var>AMinute</var>, <var>ASecond</var> and
  4433. <var>AMilliSecond</var>. If any of these values
  4434. equals the pre-defined constant <link id="RecodeLeaveFieldAsIs"/>, then
  4435. the corresponding part of the date/time stamp is left untouched.
  4436. </descr>
  4437. <errors>
  4438. If one of the values <var>AYear</var>, <var>AMonth</var>,
  4439. <var>ADay</var>, <var>AHour</var>, <var>AMinute</var>, <var>ASecond</var>
  4440. <var>AMilliSecond</var> is not within a valid range (<var>RecodeLeaveFieldAsIs</var> excepted)
  4441. then an <var>EConvertError</var> exception is raised.
  4442. </errors>
  4443. <seealso>
  4444. <link id="RecodeYear"/>
  4445. <link id="RecodeMonth"/>
  4446. <link id="RecodeDay"/>
  4447. <link id="RecodeHour"/>
  4448. <link id="RecodeMinute"/>
  4449. <link id="RecodeSecond"/>
  4450. <link id="RecodeMilliSecond"/>
  4451. <link id="RecodeDate"/>
  4452. <link id="RecodeTime"/>
  4453. <link id="TryRecodeDateTime"/>
  4454. </seealso>
  4455. <example file="datutex/ex96"/>
  4456. </element>
  4457. <!-- function result Visibility: default -->
  4458. <element name="RecodeDateTime.Result">
  4459. <short><var>AValue</var> with replaced parts</short>
  4460. </element>
  4461. <!-- argument Visibility: default -->
  4462. <element name="RecodeDateTime.AValue">
  4463. <short>Date/time to recode</short>
  4464. </element>
  4465. <!-- argument Visibility: default -->
  4466. <element name="RecodeDateTime.AYear">
  4467. <short>New value for year part</short>
  4468. </element>
  4469. <!-- argument Visibility: default -->
  4470. <element name="RecodeDateTime.AMonth">
  4471. <short>New value for month part</short>
  4472. </element>
  4473. <!-- argument Visibility: default -->
  4474. <element name="RecodeDateTime.ADay">
  4475. <short>New value for day part</short>
  4476. </element>
  4477. <!-- argument Visibility: default -->
  4478. <element name="RecodeDateTime.AHour">
  4479. <short>New value for hour part</short>
  4480. </element>
  4481. <!-- argument Visibility: default -->
  4482. <element name="RecodeDateTime.AMinute">
  4483. <short>New value for minute part</short>
  4484. </element>
  4485. <!-- argument Visibility: default -->
  4486. <element name="RecodeDateTime.ASecond">
  4487. <short>New value for second part</short>
  4488. </element>
  4489. <!-- argument Visibility: default -->
  4490. <element name="RecodeDateTime.AMilliSecond">
  4491. <short>New value for millisecond part</short>
  4492. </element>
  4493. <!-- function Visibility: default -->
  4494. <element name="TryRecodeDateTime">
  4495. <short>Replace selected parts of a <var>TDateTime</var> value with other values</short>
  4496. <descr>
  4497. <p>
  4498. <var>TryRecodeDateTime</var> replaces selected parts of the timestamp <var>AValue</var>
  4499. with the date/time values specified in <var>AYear</var>, <var>AMonth</var>,
  4500. <var>ADay</var>, <var>AHour</var>, <var>AMinute</var>, <var>ASecond</var> and
  4501. <var>AMilliSecond</var>. If any of these values
  4502. equals the pre-defined constant <link id="RecodeLeaveFieldAsIs"/>, then
  4503. the corresponding part of the date/time stamp is left untouched.
  4504. </p>
  4505. <p>
  4506. The resulting date/time is returned in <var>AValue</var>.
  4507. </p>
  4508. <p>
  4509. The function returns <var>True</var> if the encoding was succesful. It
  4510. returns <var>False</var> if one of the values <var>AYear</var>, <var>AMonth</var>,
  4511. <var>ADay</var>, <var>AHour</var>, <var>AMinute</var>, <var>ASecond</var>
  4512. <var>AMilliSecond</var> is not within a valid range.
  4513. </p>
  4514. </descr>
  4515. <seealso>
  4516. <link id="RecodeYear"/>
  4517. <link id="RecodeMonth"/>
  4518. <link id="RecodeDay"/>
  4519. <link id="RecodeHour"/>
  4520. <link id="RecodeMinute"/>
  4521. <link id="RecodeSecond"/>
  4522. <link id="RecodeMilliSecond"/>
  4523. <link id="RecodeDate"/>
  4524. <link id="RecodeTime"/>
  4525. <link id="RecodeDateTime"/>
  4526. </seealso>
  4527. <example file="datutex/ex97"/>
  4528. </element>
  4529. <!-- function result Visibility: default -->
  4530. <element name="TryRecodeDateTime.Result">
  4531. <short><var>True</var> if the recoding was succesful, <var>False</var> if not.</short>
  4532. </element>
  4533. <!-- argument Visibility: default -->
  4534. <element name="TryRecodeDateTime.AValue">
  4535. <short>Date/time to recode</short>
  4536. </element>
  4537. <!-- argument Visibility: default -->
  4538. <element name="TryRecodeDateTime.AYear">
  4539. <short>New value for year part</short>
  4540. </element>
  4541. <!-- argument Visibility: default -->
  4542. <element name="TryRecodeDateTime.AMonth">
  4543. <short>New value for month part</short>
  4544. </element>
  4545. <!-- argument Visibility: default -->
  4546. <element name="TryRecodeDateTime.ADay">
  4547. <short>New value for day part</short>
  4548. </element>
  4549. <!-- argument Visibility: default -->
  4550. <element name="TryRecodeDateTime.AHour">
  4551. <short>New value for hour part</short>
  4552. </element>
  4553. <!-- argument Visibility: default -->
  4554. <element name="TryRecodeDateTime.AMinute">
  4555. <short>New value for minute part</short>
  4556. </element>
  4557. <!-- argument Visibility: default -->
  4558. <element name="TryRecodeDateTime.ASecond">
  4559. <short>New value for second part</short>
  4560. </element>
  4561. <!-- argument Visibility: default -->
  4562. <element name="TryRecodeDateTime.AMilliSecond">
  4563. <short>New value for millisecond part</short>
  4564. </element>
  4565. <!-- argument Visibility: default -->
  4566. <element name="TryRecodeDateTime.AResult">
  4567. <short>Recoded <var>AValue</var>.</short>
  4568. </element>
  4569. <!-- function Visibility: default -->
  4570. <element name="CompareDateTime">
  4571. <short>Compare 2 dates, taking into account the time of day</short>
  4572. <descr>
  4573. <p>
  4574. <var>CompareDateTime</var> compares two timestamps <var>A</var> and
  4575. <var>B</var> and returns the following results:
  4576. </p>
  4577. <dl>
  4578. <dt>&lt; 0</dt><dd>if <var>A</var> is earlier in date/time than <var>B</var>.</dd>
  4579. <dt>0</dt><dd>if <var>A</var> and <var>B</var> are the same date/time .</dd>
  4580. <dt>&gt; 0</dt><dd>if <var>A</var> is later in date/time than <var>B</var>.</dd>
  4581. </dl>
  4582. </descr>
  4583. <seealso>
  4584. <link id="CompareTime"/>
  4585. <link id="CompareDate"/>
  4586. <link id="SameDate"/>
  4587. <link id="SameTime"/>
  4588. <link id="SameDateTime"/>
  4589. </seealso>
  4590. <example file="datutex/ex98"/>
  4591. </element>
  4592. <!-- function result Visibility: default -->
  4593. <element name="CompareDateTime.Result">
  4594. <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>
  4595. </element>
  4596. <!-- argument Visibility: default -->
  4597. <element name="CompareDateTime.A">
  4598. <short>First date-time to compare</short>
  4599. </element>
  4600. <!-- argument Visibility: default -->
  4601. <element name="CompareDateTime.B">
  4602. <short>First date-time to compare</short>
  4603. </element>
  4604. <!-- function Visibility: default -->
  4605. <element name="CompareDate">
  4606. <short>Compare 2 dates, disregarding the time of day</short>
  4607. <descr>
  4608. <p>
  4609. <var>CompareDate</var> compares the date parts of two timestamps <var>A</var> and
  4610. <var>B</var> and returns the following results:
  4611. </p>
  4612. <dl>
  4613. <dt>&lt; 0</dt><dd>if the day part of <var>A</var> is earlier than the day part of <var>B</var>.</dd>
  4614. <dt>0</dt><dd>if <var>A</var> and <var>B</var> are the on same day (times may differ) .</dd>
  4615. <dt>&gt; 0</dt><dd>if the day part of <var>A</var> is later than the day part of <var>B</var>.</dd>
  4616. </dl>
  4617. </descr>
  4618. <seealso>
  4619. <link id="CompareTime"/>
  4620. <link id="CompareDateTime"/>
  4621. <link id="SameDate"/>
  4622. <link id="SameTime"/>
  4623. <link id="SameDateTime"/>
  4624. </seealso>
  4625. <example file="datutex/ex99"/>
  4626. </element>
  4627. <!-- function result Visibility: default -->
  4628. <element name="CompareDate.Result">
  4629. <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>
  4630. </element>
  4631. <!-- argument Visibility: default -->
  4632. <element name="CompareDate.A">
  4633. <short>First date to compare</short>
  4634. </element>
  4635. <!-- argument Visibility: default -->
  4636. <element name="CompareDate.B">
  4637. <short>Second date to compare</short>
  4638. </element>
  4639. <!-- function Visibility: default -->
  4640. <element name="CompareTime">
  4641. <short>Compares two times of the day, disregarding the date part.</short>
  4642. <descr>
  4643. <p>
  4644. <var>CompareTime</var> compares the time parts of two timestamps <var>A</var> and
  4645. <var>B</var> and returns the following results:
  4646. </p>
  4647. <dl>
  4648. <dt>&lt; 0</dt><dd>if the time part of <var>A</var> is earlier than the time part of <var>B</var>.</dd>
  4649. <dt>0</dt><dd>if <var>A</var> and <var>B</var> have the same time part (dates may differ) .</dd>
  4650. <dt>&gt; 0</dt><dd>if the time part of <var>A</var> is later than the time part of <var>B</var>.</dd>
  4651. </dl>
  4652. </descr>
  4653. <seealso>
  4654. <link id="CompareDateTime"/>
  4655. <link id="CompareDate"/>
  4656. <link id="SameDate"/>
  4657. <link id="SameTime"/>
  4658. <link id="SameDateTime"/>
  4659. </seealso>
  4660. <example file="datutex/ex100"/>
  4661. </element>
  4662. <!-- function result Visibility: default -->
  4663. <element name="CompareTime.Result">
  4664. <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>
  4665. </element>
  4666. <!-- argument Visibility: default -->
  4667. <element name="CompareTime.A">
  4668. <short>First time to compare</short>
  4669. </element>
  4670. <!-- argument Visibility: default -->
  4671. <element name="CompareTime.B">
  4672. <short>Second time to compare</short>
  4673. </element>
  4674. <!-- function Visibility: default -->
  4675. <element name="SameDateTime">
  4676. <short>Check whether two <var>TDateTime</var> values have the same date and time parts.</short>
  4677. <descr>
  4678. <p>
  4679. <var>SameDateTime</var> compares the date/time parts of two timestamps <var>A</var> and
  4680. <var>B</var> and returns <var>True</var> if they are equal, <var>False</var>
  4681. if they are not.
  4682. </p>
  4683. <p>
  4684. The function simply checks whether <link id="CompareDateTime"/> returns zero.
  4685. </p>
  4686. </descr>
  4687. <seealso>
  4688. <link id="CompareDateTime"/>
  4689. <link id="CompareDate"/>
  4690. <link id="CompareTime"/>
  4691. <link id="SameDate"/>
  4692. <link id="SameTime"/>
  4693. </seealso>
  4694. <example file="datutex/ex101"/>
  4695. </element>
  4696. <!-- function result Visibility: default -->
  4697. <element name="SameDateTime.Result">
  4698. <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>
  4699. </element>
  4700. <!-- argument Visibility: default -->
  4701. <element name="SameDateTime.A">
  4702. <short>First DateTime value</short>
  4703. </element>
  4704. <!-- argument Visibility: default -->
  4705. <element name="SameDateTime.B">
  4706. <short>Second DateTime value</short>
  4707. </element>
  4708. <!-- function Visibility: default -->
  4709. <element name="SameDate">
  4710. <short>Check whether two <var>TDateTime</var> values have the same date part.</short>
  4711. <descr>
  4712. <p>
  4713. <var>SameDate</var> compares the date parts of two timestamps <var>A</var> and
  4714. <var>B</var> and returns <var>True</var> if they are equal, <var>False</var>
  4715. if they are not.
  4716. </p>
  4717. <p>
  4718. The function simply checks whether <link id="CompareDate"/> returns zero.
  4719. </p>
  4720. </descr>
  4721. <seealso>
  4722. <link id="CompareDateTime"/>
  4723. <link id="CompareDate"/>
  4724. <link id="CompareTime"/>
  4725. <link id="SameDateTime"/>
  4726. <link id="SameTime"/>
  4727. </seealso>
  4728. <example file="datutex/ex102"/>
  4729. </element>
  4730. <!-- function result Visibility: default -->
  4731. <element name="SameDate.Result">
  4732. <short><var>True</var> if <var>A</var> and <var>B</var> have the same time part, <var>False</var> if not</short>
  4733. </element>
  4734. <!-- argument Visibility: default -->
  4735. <element name="SameDate.A">
  4736. <short>First DateTime value</short>
  4737. </element>
  4738. <!-- argument Visibility: default -->
  4739. <element name="SameDate.B">
  4740. <short>Second DateTime value</short>
  4741. </element>
  4742. <!-- function Visibility: default -->
  4743. <element name="SameTime">
  4744. <short>Check whether two <var>TDateTime</var> values have the same time part.</short>
  4745. <descr>
  4746. <p>
  4747. <var>SameTime</var> compares the time parts of two timestamps <var>A</var> and
  4748. <var>B</var> and returns <var>True</var> if they are equal, <var>False</var>
  4749. if they are not.
  4750. </p>
  4751. <p>
  4752. The function simply checks whether <link id="CompareTime"/> returns zero.
  4753. </p>
  4754. </descr>
  4755. <seealso>
  4756. <link id="CompareDateTime"/>
  4757. <link id="CompareDate"/>
  4758. <link id="CompareTime"/>
  4759. <link id="SameDateTime"/>
  4760. <link id="SameDate"/>
  4761. </seealso>
  4762. <example file="datutex/ex103"/>
  4763. </element>
  4764. <!-- function result Visibility: default -->
  4765. <element name="SameTime.Result">
  4766. <short><var>True</var> if <var>A</var> and <var>B</var> have the same time part, <var>False</var> if not.</short>
  4767. </element>
  4768. <!-- argument Visibility: default -->
  4769. <element name="SameTime.A">
  4770. <short>First DateTime value</short>
  4771. </element>
  4772. <!-- argument Visibility: default -->
  4773. <element name="SameTime.B">
  4774. <short>Second DateTime value</short>
  4775. </element>
  4776. <!-- function Visibility: default -->
  4777. <element name="NthDayOfWeek">
  4778. <short>Calculate which occurrence of weekday in the month a given day represents</short>
  4779. <descr>
  4780. <var>NthDayOfWeek</var> returns the occurence of the weekday of <var>AValue</var> in the
  4781. month. This is the N-th time that this weekday occurs in the month (e.g. the
  4782. third saturday of the month).
  4783. </descr>
  4784. <seealso>
  4785. <link id="EncodeDateMonthWeek"/>
  4786. <link id="#rtl.sysutils.DayOfWeek"/>
  4787. <link id="DecodeDayOfWeekInMonth"/>
  4788. <link id="EncodeDayOfWeekInMonth"/>
  4789. <link id="TryEncodeDayOfWeekInMonth"/>
  4790. </seealso>
  4791. <example file="datutex/ex104"/>
  4792. </element>
  4793. <!-- function result Visibility: default -->
  4794. <element name="NthDayOfWeek.Result">
  4795. <short>Occurrence of weekday in the month of <var>AValue</var>.</short>
  4796. </element>
  4797. <!-- argument Visibility: default -->
  4798. <element name="NthDayOfWeek.AValue">
  4799. <short>Date to check.</short>
  4800. </element>
  4801. <!-- procedure Visibility: default -->
  4802. <element name="DecodeDayOfWeekInMonth">
  4803. <short>Decode a DateTime value in year, month, day of week parts</short>
  4804. <descr>
  4805. <var>DecodeDayOfWeekInMonth</var> decodes the date <var>AValue</var> in a
  4806. <var>AYear</var>, <var>AMonth</var>, <var>ADayOfweek</var> and
  4807. <var>ANthDayOfweek</var>.
  4808. (This is the N-th time that this weekday occurs in the month, e.g. the
  4809. third saturday of the month.)
  4810. </descr>
  4811. <seealso>
  4812. <link id="NthDayOfWeek"/>
  4813. <link id="EncodeDateMonthWeek"/>
  4814. <link id="#rtl.sysutils.DayOfWeek"/>
  4815. <link id="EncodeDayOfWeekInMonth"/>
  4816. <link id="TryEncodeDayOfWeekInMonth"/>
  4817. </seealso>
  4818. <example file="datutex/ex105"/>
  4819. </element>
  4820. <!-- argument Visibility: default -->
  4821. <element name="DecodeDayOfWeekInMonth.AValue">
  4822. <short>DateTime to decode</short>
  4823. </element>
  4824. <!-- argument Visibility: default -->
  4825. <element name="DecodeDayOfWeekInMonth.AYear">
  4826. <short>Returns the year part of <var>AValue</var>.</short>
  4827. </element>
  4828. <!-- argument Visibility: default -->
  4829. <element name="DecodeDayOfWeekInMonth.AMonth">
  4830. <short>Returns the month part of <var>AValue</var>.</short>
  4831. </element>
  4832. <!-- argument Visibility: default -->
  4833. <element name="DecodeDayOfWeekInMonth.ANthDayOfWeek">
  4834. <short>Returns which <var>ADayofWeek</var> of <var>AValue</var>.</short>
  4835. </element>
  4836. <!-- argument Visibility: default -->
  4837. <element name="DecodeDayOfWeekInMonth.ADayOfWeek">
  4838. <short>Returns the day of week part of <var>AValue</var>.</short>
  4839. </element>
  4840. <!-- function Visibility: default -->
  4841. <element name="EncodeDayOfWeekInMonth">
  4842. <short>Encodes a year, month, week, day of week specification to a <var>TDateTime</var> value</short>
  4843. <descr>
  4844. <p>
  4845. <var>EncodeDayOfWeekInMonth</var> encodes <var>AYear</var>, <var>AMonth</var>,
  4846. <var>ADayOfweek</var> and <var>ANthDayOfweek</var> to a valid date stamp and
  4847. returns the result.
  4848. </p>
  4849. <p>
  4850. <var>ANthDayOfweek</var>is the N-th time that this weekday occurs in the month, e.g. the
  4851. third saturday of the month.
  4852. </p>
  4853. <p>
  4854. For an example, see <link id="DecodeDayOfWeekInMonth"/>.
  4855. </p>
  4856. </descr>
  4857. <errors>
  4858. If any of the values is not in range, then an <var>EConvertError</var>
  4859. exception will be raised.
  4860. </errors>
  4861. <seealso>
  4862. <link id="NthDayOfWeek"/>
  4863. <link id="EncodeDateMonthWeek"/>
  4864. <link id="#rtl.sysutils.DayOfWeek"/>
  4865. <link id="DecodeDayOfWeekInMonth"/>
  4866. <link id="TryEncodeDayOfWeekInMonth"/>
  4867. </seealso>
  4868. </element>
  4869. <!-- function result Visibility: default -->
  4870. <element name="EncodeDayOfWeekInMonth.Result">
  4871. <short><var>TDateTime</var> value representing <var>AYear</var> , <var>AMonth</var><var>ANthDayOfWeek</var> .and <var>ADayOfWeek</var>.</short>
  4872. </element>
  4873. <!-- argument Visibility: default -->
  4874. <element name="EncodeDayOfWeekInMonth.AYear">
  4875. <short>Year</short>
  4876. </element>
  4877. <!-- argument Visibility: default -->
  4878. <element name="EncodeDayOfWeekInMonth.AMonth">
  4879. <short>Month in the year</short>
  4880. </element>
  4881. <!-- argument Visibility: default -->
  4882. <element name="EncodeDayOfWeekInMonth.ANthDayOfWeek">
  4883. <short>Week in the month</short>
  4884. </element>
  4885. <!-- argument Visibility: default -->
  4886. <element name="EncodeDayOfWeekInMonth.ADayOfWeek">
  4887. <short>Day of the week</short>
  4888. </element>
  4889. <!-- function Visibility: default -->
  4890. <element name="TryEncodeDayOfWeekInMonth">
  4891. <short>Encode a year, month, week, day of week triplet to a <var>TDateTime</var> value</short>
  4892. <descr>
  4893. <p>
  4894. <var>EncodeDayOfWeekInMonth</var> encodes
  4895. <var>AYear</var>, <var>AMonth</var>, <var>ADayOfweek</var> and
  4896. <var>ANthDayOfweek</var> to a valid date stamp and returns the result in
  4897. <var>AValue</var>.
  4898. </p>
  4899. <p>
  4900. <var>ANthDayOfweek</var>is the N-th time that this weekday occurs in the month, e.g. the
  4901. third saturday of the month.
  4902. </p>
  4903. <p>
  4904. The function returns <var>True</var> if the encoding was succesful,
  4905. <var>False</var> if any of the values is not in range.
  4906. </p>
  4907. </descr>
  4908. <seealso>
  4909. <link id="NthDayOfWeek"/>
  4910. <link id="EncodeDateMonthWeek"/>
  4911. <link id="#rtl.sysutils.DayOfWeek"/>
  4912. <link id="DecodeDayOfWeekInMonth"/>
  4913. <link id="EncodeDayOfWeekInMonth"/>
  4914. </seealso>
  4915. <example file="datutex/ex106"/>
  4916. </element>
  4917. <!-- function result Visibility: default -->
  4918. <element name="TryEncodeDayOfWeekInMonth.Result">
  4919. <short><var>True</var> if the encoding was succesful, <var>False</var> if not.</short>
  4920. </element>
  4921. <!-- argument Visibility: default -->
  4922. <element name="TryEncodeDayOfWeekInMonth.AYear">
  4923. <short>Year</short>
  4924. </element>
  4925. <!-- argument Visibility: default -->
  4926. <element name="TryEncodeDayOfWeekInMonth.AMonth">
  4927. <short>Month in year</short>
  4928. </element>
  4929. <!-- argument Visibility: default -->
  4930. <element name="TryEncodeDayOfWeekInMonth.ANthDayOfWeek">
  4931. <short>Day of week occurrence</short>
  4932. </element>
  4933. <!-- argument Visibility: default -->
  4934. <element name="TryEncodeDayOfWeekInMonth.ADayOfWeek">
  4935. <short>Day of week</short>
  4936. </element>
  4937. <!-- argument Visibility: default -->
  4938. <element name="TryEncodeDayOfWeekInMonth.AValue">
  4939. <short>Resulting TDateTime value</short>
  4940. </element>
  4941. <!-- argument Visibility: default -->
  4942. <element name="InvalidDateTimeError.ABaseDate">
  4943. <short>Base date time to use when creating the string representing the date/time. Default 0</short>
  4944. </element>
  4945. <!-- procedure Visibility: default -->
  4946. <element name="InvalidDateTimeError">
  4947. <short>Raise an <var>EConvertError</var> about an invalid date-time specification.</short>
  4948. <descr>
  4949. <p>
  4950. <var>InvalidDateTimeError</var> raises an <link id="#rtl.sysutils.EConvertError">EConvertError</link>
  4951. exception and formats the error message with an appropriate description made
  4952. up from the parts <var>AYear</var>, <var>AMonth</var>,
  4953. <var>ADay</var>,<var>AHour</var>, <var>AMinute</var>, <var>ASecond</var> and
  4954. <var>AMilliSecond</var>.
  4955. </p>
  4956. <p>
  4957. Normally this function should not be needed, the conversion routines call it
  4958. when they have received invalid arguments.
  4959. </p>
  4960. </descr>
  4961. <seealso>
  4962. <link id="InvalidDateWeekError"/>
  4963. <link id="InvalidDateDayError"/>
  4964. <link id="InvalidDateMonthWeekError"/>
  4965. <link id="InvalidDayOfWeekInMonthError"/>
  4966. </seealso>
  4967. </element>
  4968. <!-- argument Visibility: default -->
  4969. <element name="InvalidDateTimeError.AYear">
  4970. <short>Year</short>
  4971. </element>
  4972. <!-- argument Visibility: default -->
  4973. <element name="InvalidDateTimeError.AMonth">
  4974. <short>Month in the year</short>
  4975. </element>
  4976. <!-- argument Visibility: default -->
  4977. <element name="InvalidDateTimeError.ADay">
  4978. <short>Day of the month</short>
  4979. </element>
  4980. <!-- argument Visibility: default -->
  4981. <element name="InvalidDateTimeError.AHour">
  4982. <short>Hour of the day</short>
  4983. </element>
  4984. <!-- argument Visibility: default -->
  4985. <element name="InvalidDateTimeError.AMinute">
  4986. <short>Minute of the hour</short>
  4987. </element>
  4988. <!-- argument Visibility: default -->
  4989. <element name="InvalidDateTimeError.ASecond">
  4990. <short>Seconds in the minute</short>
  4991. </element>
  4992. <!-- argument Visibility: default -->
  4993. <element name="InvalidDateTimeError.AMilliSecond">
  4994. <short>Milliseconds in second</short>
  4995. </element>
  4996. <!-- procedure Visibility: default -->
  4997. <element name="InvalidDateWeekError">
  4998. <short>Raise an EConvertError with an invalid Year, WeekOfyear and DayOfWeek specification</short>
  4999. <descr>
  5000. <p>
  5001. <var>InvalidDateWeekError</var> raises an <link id="#rtl.sysutils.EConvertError">EConvertError</link>
  5002. exception and formats the error message with an appropriate description made
  5003. up from the parts <var>AYear</var>, <var>AWeek</var>,
  5004. <var>ADayOfWeek</var>
  5005. </p>
  5006. <p>
  5007. Normally this function should not be needed, the conversion routines call it
  5008. when they have received invalid arguments.
  5009. </p>
  5010. </descr>
  5011. <seealso>
  5012. <link id="InvalidDateTimeError"/>
  5013. <link id="InvalidDateDayError"/>
  5014. <link id="InvalidDateMonthWeekError"/>
  5015. <link id="InvalidDayOfWeekInMonthError"/>
  5016. </seealso>
  5017. </element>
  5018. <element name="InvalidDateWeekError.AYear">
  5019. <short>The year</short>
  5020. </element>
  5021. <element name="InvalidDateWeekError.AWeekOfYear">
  5022. <short>The week</short>
  5023. </element>
  5024. <element name="InvalidDateWeekError.ADayOfweek">
  5025. <short>The day of theweek</short>
  5026. </element>
  5027. <!-- procedure Visibility: default -->
  5028. <element name="InvalidDateDayError">
  5029. <short>Raise an <var>EConvertError</var> exception when a day is not a valid day of a year.</short>
  5030. <descr>
  5031. <p>
  5032. <var>InvalidDateDayError</var> raises an <link id="#rtl.sysutils.EConvertError">EConvertError</link>
  5033. exception and formats the error message with an appropriate description made
  5034. up from the parts <var>AYear</var> and <var>ADayOfYear</var>.
  5035. </p>
  5036. <p>
  5037. Normally this function should not be needed, the conversion routines call it
  5038. when they have received invalid arguments.
  5039. </p>
  5040. </descr>
  5041. <seealso>
  5042. <link id="InvalidDateWeekError"/>
  5043. <link id="InvalidDateTimeError"/>
  5044. <link id="InvalidDateMonthWeekError"/>
  5045. <link id="InvalidDayOfWeekInMonthError"/>
  5046. </seealso>
  5047. </element>
  5048. <!-- argument Visibility: default -->
  5049. <element name="InvalidDateDayError.AYear">
  5050. <short>Year</short>
  5051. </element>
  5052. <!-- argument Visibility: default -->
  5053. <element name="InvalidDateDayError.ADayOfYear">
  5054. <short>Invalid day of the year.</short>
  5055. </element>
  5056. <!-- procedure Visibility: default -->
  5057. <element name="InvalidDateMonthWeekError">
  5058. <short>Raise an <var>EConvertError</var> exception when a Year,Month,WeekOfMonth,DayofWeek is invalid.</short>
  5059. <descr>
  5060. <p>
  5061. <var>InvalidDateMonthWeekError</var> raises an <link id="#rtl.sysutils.EConvertError">EConvertError</link>
  5062. exception and formats the error message with an appropriate description made
  5063. up from the parts <var>AYear</var>, <var>Amonth</var>,
  5064. <var>AWeekOfMonth</var> and <var>ADayOfWeek</var>.
  5065. </p>
  5066. <p>
  5067. Normally this function should not be needed, the conversion routines call it
  5068. when they have received invalid arguments.
  5069. </p>
  5070. </descr>
  5071. <seealso>
  5072. <link id="InvalidDateWeekError"/>
  5073. <link id="InvalidDateTimeError"/>
  5074. <link id="InvalidDateDayError"/>
  5075. <link id="InvalidDayOfWeekInMonthError"/>
  5076. </seealso>
  5077. </element>
  5078. <!-- argument Visibility: default -->
  5079. <element name="InvalidDateMonthWeekError.AYear">
  5080. <short>Year</short>
  5081. </element>
  5082. <!-- argument Visibility: default -->
  5083. <element name="InvalidDateMonthWeekError.AMonth">
  5084. <short>Month of the year</short>
  5085. </element>
  5086. <!-- argument Visibility: default -->
  5087. <element name="InvalidDateMonthWeekError.AWeekOfMonth">
  5088. <short>Week of the month</short>
  5089. </element>
  5090. <!-- argument Visibility: default -->
  5091. <element name="InvalidDateMonthWeekError.ADayOfWeek">
  5092. <short>Day of the week</short>
  5093. </element>
  5094. <!-- procedure Visibility: default -->
  5095. <element name="InvalidDayOfWeekInMonthError">
  5096. <short>Raise an <var>EConvertError</var> exception when a Year,Month,NthDayofWeek,DayofWeek is invalid.</short>
  5097. <descr>
  5098. <p>
  5099. <var>InvalidDayOfWeekInMonthError</var> raises an <link id="#rtl.sysutils.EConvertError">EConvertError</link>
  5100. exception and formats the error message with an appropriate description made
  5101. up from the parts <var>AYear</var>, <var>Amonth</var>,
  5102. <var>ANthDayOfWeek</var> and <var>ADayOfWeek</var>.
  5103. </p>
  5104. <p>
  5105. Normally this function should not be needed, the conversion routines call it
  5106. when they have received invalid arguments.
  5107. </p>
  5108. </descr>
  5109. <seealso>
  5110. <link id="InvalidDateWeekError"/>
  5111. <link id="InvalidDateTimeError"/>
  5112. <link id="InvalidDateDayError"/>
  5113. <link id="InvalidDateMonthWeekError"/>
  5114. </seealso>
  5115. </element>
  5116. <!-- argument Visibility: default -->
  5117. <element name="InvalidDayOfWeekInMonthError.AYear">
  5118. <short>Year</short>
  5119. </element>
  5120. <!-- argument Visibility: default -->
  5121. <element name="InvalidDayOfWeekInMonthError.AMonth">
  5122. <short>Month in the year</short>
  5123. </element>
  5124. <!-- argument Visibility: default -->
  5125. <element name="InvalidDayOfWeekInMonthError.ANthDayOfWeek">
  5126. <short>Nth occurrence of day of week.</short>
  5127. </element>
  5128. <!-- argument Visibility: default -->
  5129. <element name="InvalidDayOfWeekInMonthError.ADayOfWeek">
  5130. <short>Day of week.</short>
  5131. </element>
  5132. <!-- function Visibility: default -->
  5133. <element name="DateTimeToJulianDate">
  5134. <short>Converts a TDateTime value to a Julian date representation</short>
  5135. <descr>
  5136. Not yet implemented.
  5137. </descr>
  5138. <errors>
  5139. Currently, trying to use this function will raise an exception.
  5140. </errors>
  5141. <seealso>
  5142. <link id="JulianDateToDateTime"/>
  5143. <link id="TryJulianDateToDateTime"/>
  5144. <link id="DateTimeToModifiedJulianDate"/>
  5145. <link id="TryModifiedJulianDateToDateTime"/>
  5146. </seealso>
  5147. </element>
  5148. <!-- function result Visibility: default -->
  5149. <element name="DateTimeToJulianDate.Result">
  5150. <short>Julian representation of <var>AValue</var>.</short>
  5151. </element>
  5152. <!-- argument Visibility: default -->
  5153. <element name="DateTimeToJulianDate.AValue">
  5154. <short>DateTime value to convert to Julian representation</short>
  5155. </element>
  5156. <!-- function Visibility: default -->
  5157. <element name="JulianDateToDateTime">
  5158. <short>Convert a Julian date representation to a <var>TDateTime</var> value.</short>
  5159. <descr>
  5160. Not yet implemented.
  5161. </descr>
  5162. <errors>
  5163. Currently, trying to use this function will raise an exception.
  5164. </errors>
  5165. <seealso>
  5166. <link id="DateTimeToJulianDate"/>
  5167. <link id="TryJulianDateToDateTime"/>
  5168. <link id="DateTimeToModifiedJulianDate"/>
  5169. <link id="TryModifiedJulianDateToDateTime"/>
  5170. </seealso>
  5171. </element>
  5172. <!-- function result Visibility: default -->
  5173. <element name="JulianDateToDateTime.Result">
  5174. <short>Resulting <var>TDateTime</var></short>
  5175. </element>
  5176. <!-- argument Visibility: default -->
  5177. <element name="JulianDateToDateTime.AValue">
  5178. <short>Date in Julian notation</short>
  5179. </element>
  5180. <!-- function Visibility: default -->
  5181. <element name="TryJulianDateToDateTime">
  5182. <short>Convert a Julian date representation to a <var>TDateTime</var> value.</short>
  5183. <descr>
  5184. Not yet implemented.
  5185. </descr>
  5186. <errors>
  5187. Currently, trying to use this function will raise an exception.
  5188. </errors>
  5189. <seealso>
  5190. <link id="DateTimeToJulianDate"/>
  5191. <link id="JulianDateToDateTime"/>
  5192. <link id="DateTimeToModifiedJulianDate"/>
  5193. <link id="TryModifiedJulianDateToDateTime"/>
  5194. </seealso>
  5195. </element>
  5196. <!-- function result Visibility: default -->
  5197. <element name="TryJulianDateToDateTime.Result">
  5198. <short><var>True</var> if the conversion was succesful, <var>False</var> if not.</short>
  5199. </element>
  5200. <!-- argument Visibility: default -->
  5201. <element name="TryJulianDateToDateTime.AValue">
  5202. <short>Date in Julian notation</short>
  5203. </element>
  5204. <!-- argument Visibility: default -->
  5205. <element name="TryJulianDateToDateTime.ADateTime">
  5206. <short>Resulting <var>TDateTime</var> equivalent</short>
  5207. </element>
  5208. <!-- function Visibility: default -->
  5209. <element name="DateTimeToModifiedJulianDate">
  5210. <short>Convert a <var>TDateTime</var> value to a modified Julian date representation</short>
  5211. <descr>
  5212. Not yet implemented.
  5213. </descr>
  5214. <errors>
  5215. Currently, trying to use this function will raise an exception.
  5216. </errors>
  5217. <seealso>
  5218. <link id="DateTimeToJulianDate"/>
  5219. <link id="JulianDateToDateTime"/>
  5220. <link id="TryJulianDateToDateTime"/>
  5221. <link id="TryModifiedJulianDateToDateTime"/>
  5222. </seealso>
  5223. </element>
  5224. <!-- function result Visibility: default -->
  5225. <element name="DateTimeToModifiedJulianDate.Result">
  5226. <short>Modified Julian representation of <var>AValue</var>.</short>
  5227. </element>
  5228. <!-- argument Visibility: default -->
  5229. <element name="DateTimeToModifiedJulianDate.AValue">
  5230. <short>DateTime value to convert to Modified Julian representation</short>
  5231. </element>
  5232. <!-- function Visibility: default -->
  5233. <element name="ModifiedJulianDateToDateTime">
  5234. <short>Convert a modified Julian date representation to a <var>TDateTime</var> value.</short>
  5235. <descr>
  5236. Not yet implemented.
  5237. </descr>
  5238. <errors>
  5239. Currently, trying to use this function will raise an exception.
  5240. </errors>
  5241. <seealso>
  5242. <link id="DateTimeToJulianDate"/>
  5243. <link id="JulianDateToDateTime"/>
  5244. <link id="TryJulianDateToDateTime"/>
  5245. <link id="DateTimeToModifiedJulianDate"/>
  5246. <link id="TryModifiedJulianDateToDateTime"/>
  5247. </seealso>
  5248. </element>
  5249. <!-- function result Visibility: default -->
  5250. <element name="ModifiedJulianDateToDateTime.Result">
  5251. <short><var>AValue</var> in modified Julian date notation.</short>
  5252. </element>
  5253. <!-- argument Visibility: default -->
  5254. <element name="ModifiedJulianDateToDateTime.AValue">
  5255. <short>Date to convert</short>
  5256. </element>
  5257. <!-- function Visibility: default -->
  5258. <element name="TryModifiedJulianDateToDateTime">
  5259. <short>Convert a modified Julian date representation to a <var>TDateTime</var> value.</short>
  5260. <descr>
  5261. Not yet implemented.
  5262. </descr>
  5263. <errors>
  5264. Currently, trying to use this function will raise an exception.
  5265. </errors>
  5266. <seealso>
  5267. <link id="DateTimeToJulianDate"/>
  5268. <link id="JulianDateToDateTime"/>
  5269. <link id="TryJulianDateToDateTime"/>
  5270. <link id="DateTimeToModifiedJulianDate"/>
  5271. <link id="ModifiedJulianDateToDateTime"/>
  5272. </seealso>
  5273. </element>
  5274. <!-- function result Visibility: default -->
  5275. <element name="TryModifiedJulianDateToDateTime.Result">
  5276. <short><var>True</var> if the conversion was succesful, <var>False</var> if not.</short>
  5277. </element>
  5278. <!-- argument Visibility: default -->
  5279. <element name="TryModifiedJulianDateToDateTime.AValue">
  5280. <short>Modified Julian date to convert</short>
  5281. </element>
  5282. <!-- argument Visibility: default -->
  5283. <element name="TryModifiedJulianDateToDateTime.ADateTime">
  5284. <short><var>AValue</var> as a <var>TDateTime</var> value.</short>
  5285. </element>
  5286. <!-- function Visibility: default -->
  5287. <element name="DateTimeToUnix">
  5288. <short>Convert a <var>TDateTime</var> value to Unix epoch time</short>
  5289. <descr>
  5290. Not yet implemented.
  5291. </descr>
  5292. <errors>
  5293. Currently, trying to use this function will raise an exception.
  5294. </errors>
  5295. <seealso>
  5296. <link id="UnixToDateTime"/>
  5297. </seealso>
  5298. </element>
  5299. <!-- function result Visibility: default -->
  5300. <element name="DateTimeToUnix.Result">
  5301. <short>Unix epoch time corresponding to <var>AValue</var></short>
  5302. </element>
  5303. <!-- argument Visibility: default -->
  5304. <element name="DateTimeToUnix.AValue">
  5305. <short>DateTime value to convert</short>
  5306. </element>
  5307. <!-- function Visibility: default -->
  5308. <element name="UnixToDateTime">
  5309. <short>Convert Unix epoch time to a <var>TDateTime</var> value</short>
  5310. <descr>
  5311. Not yet implemented.
  5312. </descr>
  5313. <errors>
  5314. Currently, trying to use this function will raise an exception.
  5315. </errors>
  5316. <seealso>
  5317. <link id="DateTimeToUnix"/>
  5318. </seealso>
  5319. </element>
  5320. <!-- function result Visibility: default -->
  5321. <element name="UnixToDateTime.Result">
  5322. <short><var>AValue</var> as a <var>TDateTime</var> value.</short>
  5323. </element>
  5324. <!-- argument Visibility: default -->
  5325. <element name="UnixToDateTime.AValue">
  5326. <short>Date to convert.</short>
  5327. </element>
  5328. </module>
  5329. <!-- dateutils -->
  5330. </package>
  5331. </fpdoc-descriptions>