-
Notifications
You must be signed in to change notification settings - Fork 1
/
BrookUtility.Brook.html
173 lines (172 loc) · 9 KB
/
BrookUtility.Brook.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookUtility: Record Brook</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<div class="container"><div class="navigation">
<h2><a href="index.html">Brook Tardigrade</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><form class="search-form" action="tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></div></form>
<div style="clear: both"></div>
</li></ul></div><div class="content">
<span id="Brook"></span><h1 class="cio">Record Brook</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section">Hierarchy</div><div class="one_section"><a class="section" href="#PasDoc-Fields">Fields</a></div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section">Properties</div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="BrookUtility.html">BrookUtility</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type Brook = record</code></p>
<h2 class="description">Description</h2>
<p>
Global <code>Brook</code> object containing general purpose functions.</p>
<h2 class="overview">Overview</h2>
<span id="PasDoc-Fields"></span><h3 class="summary">Fields</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>nested const <strong><a href="BrookUtility.Brook.html#DAYS">DAYS</a></strong>: array[1..7] of string = ('Sun', 'Mon', 'Tue', 'Wed', 'Thu',
'Fri', 'Sat');</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>nested const <strong><a href="BrookUtility.Brook.html#MONTHS">MONTHS</a></strong>: array[1..12] of string = ('Jan', 'Feb', 'Mar', 'Apr', 'May',
'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec');</code></td>
</tr>
</table>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Brook.html#FixPath">FixPath</a></strong>(const APath: string): string; static; inline;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Brook.html#FixEntryPoint">FixEntryPoint</a></strong>(const APath: string): string; static; inline;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Brook.html#DateTimeToUTC">DateTimeToUTC</a></strong>(ADateTime: TDateTime): TDateTime; static; inline;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Brook.html#DateTimeToGMT">DateTimeToGMT</a></strong>(ADateTime: TDateTime): string; static; inline;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Brook.html#SHA1">SHA1</a></strong>(const S: string): string; static; inline;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Fields</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="DAYS"></span><code>nested const <strong>DAYS</strong>: array[1..7] of string = ('Sun', 'Mon', 'Tue', 'Wed', 'Thu',
'Fri', 'Sat');</code></td>
</tr>
<tr><td colspan="2">
<p>
Holds the name of <code>days</code> as 'Aaa' format.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="MONTHS"></span><code>nested const <strong>MONTHS</strong>: array[1..12] of string = ('Jan', 'Feb', 'Mar', 'Apr', 'May',
'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec');</code></td>
</tr>
<tr><td colspan="2">
<p>
Holds the name of <code>months</code> as 'Aaa' format.</p>
</td></tr>
</table>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="FixPath"></span><code>class function <strong>FixPath</strong>(const APath: string): string; static; inline;</code></td>
</tr>
<tr><td colspan="2">
<p>
Fixes a path by including the leading path delimiter and excluding the trailing one. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APath[in]</dt>
<dd>Path as static string.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Fixed path, e.g.: path -> /path and /path/ -> /path</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="FixEntryPoint"></span><code>class function <strong>FixEntryPoint</strong>(const APath: string): string; static; inline;</code></td>
</tr>
<tr><td colspan="2">
<p>
Extracts and fixes an entry-point by including the leading path delimiter and excluding the trailing one. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APath[in]</dt>
<dd>Path as static string.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Fixed entry-point, e.g.: /foo/bar -> /foo </p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="DateTimeToUTC"></span><code>class function <strong>DateTimeToUTC</strong>(ADateTime: TDateTime): TDateTime; static; inline;</code></td>
</tr>
<tr><td colspan="2">
<p>
Converts a given local time to UTC (Coordinated Universal Time). </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ADateTime[in]</dt>
<dd>Local date/time.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Local time converted to UTC.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="DateTimeToGMT"></span><code>class function <strong>DateTimeToGMT</strong>(ADateTime: TDateTime): string; static; inline;</code></td>
</tr>
<tr><td colspan="2">
<p>
Converts a given local time to GMT (Greenwich Mean Time). </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ADateTime[in]</dt>
<dd>Local date/time.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Local time converted to GMT string.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SHA1"></span><code>class function <strong>SHA1</strong>(const S: string): string; static; inline;</code></td>
</tr>
<tr><td colspan="2">
<p>
Generates a given string to SHA-1 (Secure Hash Algorithm 1). </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>S[in]</dt>
<dd>String to generate the SHA-1.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Generated SHA-1 as static string.</p></td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</div></div></body></html>